Bangazon Platform API

Bangazon is an api for users to buy and sell products

Local Setup

1. Clone this repository and change to the directory in the terminal.
2. Run pipenv shell
3. Run pipenv install
4. Seed database: ./seed_data.sh This will migrate and run a seed_db command. Take look at the seed_data.sh to see what it runs. Then open bangazon_api/management/commands/seed_db.py file to see what the seed_db does

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

python manage.py runserver

Bangazon ERD

Here is the ERD for the models in the api: https://drawsql.app/nss-2/diagrams/bangazon/embed

Documentation

To make it easier for onboarding new developers, there is a documentation site made with Swagger that allows the developer to make requests and view the response

1. Run the server
2. Go to http://localhost:8000/swagger
3. Find and open the register docs and click Try it out
4. Fill out the json and press Execute
5. Copy the token that is returned
6. Scroll back to the top of the page
7. Click on Authorize
8. In the value input add Token <the new token>, then click authorize
9. Try to get a list of categories in the browser
10. If this doesn't work, reach out to your senior

Once you're logged into the swagger docs, try out a few other requests so you can see what each endpoint does. There is information in the docs about what status and data will be returned with each response. If you want to switch users, look in the auth_token table to grab a different token.

Deployed client site

1. The front end of the website is deployed here: https://nss-bangazon-dev.herokuapp.com
2. It's built to work with your local api, once you have your local server running you can use the dev website to interact with the api
3. To login: open the auth_user table and copy one of the usernames that you'd like to login as. The password for each user is password