Welcome to My Backlog Handler™ from StackOverflowers Studios©

Activating Virtual Enviroments

For users to properly install dependencies for this application, a Virtual Enviroment is needed so all packages can be used properly
For Windows 10 users:
1. Enter in the Command Prompt: python -m venv venv/
2. To activate Virtual Enviroment, type in the Command Prompt: venv\Scripts\activate
3. To install project dependecies, type in the Command Prompt: pip install -r requirements.txt
4. To deactivate Virtual Enviroment, type in the Command Prompt: deactivate
For macOS & Linux users:
1. Enter in the Terminal: python -m venv venv/
2. To activate Virtual Enviroment, type in the Terminal: source venv/bin/activate
3. To install project dependecies, type in the Terminal: pip install -r requirements.txt
4. To deactivate Virtual Enviroment, type in the Terminal : deactivate

Run Django Application on localhost

This application is hosted live using the master branch on Heroku via My Backlog handler
In the case that developers need to run this application locally to test out new features, they can do so by typing in the terminal (while being in the project's root directory) the following command: python3 manage.py runserver

Add new models

For developers to use and create new models, all they need to do is to enter index/models.py and follow the similar structure that most Django data models follow, in this project there are severa created already
After a new model has been created, they need to create a ViewSet and a Serializer in the views.py and the serializers.py inside the index folder. Inside the files there are several examples that they can use

Migrating Data Models to Database

This application is using PostgreSQL as it's database, but these commands work for any DB that is registered on the settings.py file
In the case that developers need to make data model migrations so that they can store data according to their needs, they need to run the following 2 commands:
1. python3 manage.py makemigrations
2. python3 manage.py migrate --database="myDBName"

Extract Games from IGDB API

This application uses the IGDB Game API to extract game information to store it in our database
In the case that developers need to use this API they can do so by running the request.py file located in the root directory
Developers can change the endpoint queries that IGDB uses to whatever they want, for more information on this check out the official IGDB API documentation
Once the developer runs the file, a JSON file containing the parsed information from the API's query request should be generated in the res folder called data.json

Upload Parsed Game information from IGDB API to Database

If developers want to upload parsed information from the API to the database, they can do so by running the following command:

Meet the Team!

bermed28/My-Backlog-Handler