Bangazon Platform API

This is a school project replica of Bangazon API.

The purpose of this project is to immitate the tasks we would be given as a junior developer. We were given tickets where we need to resolve bugs, tests and reports

Prerequisites

Mac OS

brew install libtiff libjpeg webp little-cms2

Linux (WSL)

sudo apt-get 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

Install apidoc

npm install apidoc -g

Setup

1. Clone this repository and change to the directory in the terminal.
2. Run pipenv shell
3. Run pipenv install
4. Type this exact thing into the terminal to run the migrations and seed the database: ./seed_data.sh

Now that your database is set up all you have to do is run the command:

python manage.py runserver

Bangazon ERD

Open the Bangazon database diagram in the browser to view the tables and relationships for your database. Note that the tables names and field names are written in Pascal case, and not in snake case. Your database has everything in snake case, so while the field names are different, the resources and relationships are identical to the ERD.

Postman Request Collection

1. Open Postman
2. Click Import from the navbar
3. Choose the Link option
4. Paste in this URL: https://www.getpostman.com/collections/c29b98258d312bf240b7
5. Your should be prompted to import Bangazon Python API.
6. Click the Import button to complete the process.

To test it out, expand the Profile sub-collection, double-click on Login and send the request. You should get a response back that looks like this.

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

Documentation

To view browser-based documentation for the project, follow these steps.

1. Run ./renderdocs.sh
2. cd docs
3. Then start a simple web server like http-server or serve.
4. In your web browser, go to the URL provided by your web server.