Bangazon Platform API

System Dependencies

1. Follow installation guide for installing pipx.
2. Run pipx install poetry.
3. Run the command below for your operating system.

Mac OS

brew install libtiff libjpeg webp little-cms2

Linux

sudo apt install libtiff5-dev libjpeg8-dev libopenjp2-7-dev zlib1g-dev \
    libfreetype6-dev liblcms2-dev libwebp-dev tcl8.6-dev tk8.6-dev python3-tk \
    libharfbuzz-dev libfribidi-dev libxcb1-dev

Setup

1. Clone this repository and change to the directory in the terminal.
2. Run poetry env activate and wait for the virtual environment to be created.
3. Run poetry install to install dependencies.
4. Run pip install setuptools
5. Run migrations and install starter data with the ./seed_data.sh script.
6. Open the project in VS Code if you haven't yet.
7. Ensure that the correct Python Interpreter is chosen in VS Code.
8. Start your debugger.

Postman Request Collection

1. Open the Yaak API client
2. Click Import
3. Click Select File
4. Open the api-requests-collection.json file that is in this project.
5. Click Import to complete the process
6. You will see a confirmation that a new workspace has been created for you.

Test Login Request

1. Expand the Profile collection
2. Click on Login to open the request
3. Send the request.
4. You should get a response back that looks like this

   {
       "valid": true,
       "token": "9ba45f09651c5b0c404f37a2d2572c026c146690",
       "id": 5
   }

User Authentication

Look in the users.json file for the usernames. While the passwords in the fixture are encrypted, the source password for every user is Admin8*

Changing Your Database

You can run the ./seed-data.sh script any time to make changes to database models, or just want to roll back your data to its original state. It deletes the database, any existing migrations, and then re-creates the database based on your current models, and inserts starter data.