api/README.md
ahosking cd2e4fca26 Chore: Add Developer Documentation
Add Instructions for getting started from scratch
Add command to create/run a database for dev/testing
Specify Python version for pyenv
Update requirements for nev versions of packages
2023-03-25 11:51:36 -04:00

931 B

api

The AHosking.com API

Getting Started

  1. sudo apt install libpq-dev python-dev python3-psycopg2
  2. pip install virtualenv
  3. python3 -m virtualenv .env
  4. Activate environment .\.env\Scripts\activate
  5. export DEBUG=false
  6. docker run --name api-postgres -e POSTGRES_PASSWORD=mysecretpassword -e POSTGRES_USER=api -e POSTGRES_DB=api -p 5432:5432 -d postgres
  7. export DATABASE_HOST=localhost
    export DATABASE_PORT=5432
    export DATABASE_USER=api
    export DATABASE_PASSWORD=mysecretpassword
    export DATABASE_NAME=api
    
  8. python3 manage.py makemigrations
  9. python3 manage.py migrate
  10. python3 manage.py createsuperuser
  11. python manage.py runserver 0.0.0.0:9000

Troubleshooting

pip3 install --upgrade --force-reinstall -r requirements.txt will re-install requirements and upgrade based on requirements.txt

Third-party