CalvinChanCan/gpa-api

General Purpose Accounting (GPA) System

Requirements

Python <= 3.11 Postgresql <= 15.1

Setup

1. Download and install postgres locally.
   • Create a new database gpa
2. Clone this repository and run pip install -r requirements.txt.
3. Create .env file with the variables found in .env.example
4. Run python manage.py makemigrations gpa and python manage.py migrate
5. Run python manage.py runserver to start the api server.
6. Run python manage.py createsuperuser to create a superuser
7. Create a new user in GPA UI at 127.0.0.1:5173/signup.
   • Note: Using Django Admin at 127.0.0.1:8000/admin/ does not properly create accounts with hash passwords.
8. Use 127.0.0.1:8000/api/ to create some sample accounts and transactions.
   • Examples
     • Create new account: http://127.0.0.1:8000/api/users/1/accounts/create/
     • Create new transaction: http://127.0.0.1:8000/api/accounts/1/transactions/create/
     • Get balance of account on specified date http://localhost:8000/api/accounts/1/balance/2023-03-10/

Useful commands:

python manage.py makemigrations
python manage.py migrate
python manage.py runserver
python -m black .
python manage.py createsuperuser
python manage.py makemigrations gpa