Selah/backend/README.md

# Selah Django backend API

*** DJANGO ENVIRONMENT LOCAL SETUP (installing libraries/dependencies) ***

- install ffmpeg for audio file processing on your system ( https://www.gyan.dev/ffmpeg/builds/ ):
  sudo apt-get install net-tools
  sudo apt install ffmpeg
  NOTE:
  if using Windows, download 7-zip (https://www.7-zip.org/download.html) to extract the ffmpeg binaries; after extracting the binaries, add the path wherever you placed these files to your user's PATH environment variable
- install postgres
  sudo apt install libpq-dev
  sudo apt install postgresql
  sudo apt install postgresql-contrib
- make sure python is installed (should come with ubuntu):
  python (or python3) --version
  Django setup (Using Python -v 3.10.6 and Django -v 4.2 as of April, 29, 2023):
- make dir on local machine where this project will be located
- clone this repo from github
- install python venv:
  sudo apt install python3.10-venv
- Create python virtual environment on local machine:

python3 -m venv env

- Activate python virtual environment on local machine:

. env/bin/activate (linux)

source env/Scripts/activate (Unix/Mac)

or

env\Scripts\activate (Windows)

you'll see '(env)' on the left-most side the terminal signature when activated

- Once your env is activated, install Django and other dependencies:

`pip install -r requirements.txt`

- Description of dependencies below:

pip install django (the backend framework)
pip install django-rest-framework (creating the backend API, creates djangorestframework dir as well)
pip install djangorestframework-simplejwt (Simple JWT provides a JSON Web Token authentication backend for the Django REST Framework. Updated framework from djangorestframework-jwt which is now deprecated)
pip install pyjwt (Python library which allows you to encode and decode JSON Web Tokens JWT)
pip install social-auth-app-django (for 3rd party auth Facebook, Google, LinkedIn, etc.)
pip install django-cors-headers (provides security between backend and API)
pip install djoser (assists with user auth)
pip install pillow (image processing)
pip install django-imagekit (django image processing for track image)
pip install pydub (audio file processing)
pip install django-environ (for environment variables)
pip install stripe (payment processor for handling secure payments)
pip3 install --upgrade stripe (upgrade stripe)
pip install psycopg2 (database adapter for PostgreSQL DB. Use this for local development, but in the production server, install the binary:
pip install psycopg2-binary
)

- install pgadmin4 desktop tool for DB management (https://www.pgadmin.org/download/)
  pip install gunicorn

You need to create and setup an empty PostgreSQL DB on your machine through either the psql shell or pgadmin tool for this project before running `python manage.py makemigrations` and `python manage.py migrate` (If you want to use custom user model, **DO NOT RUN** python manage.py makemigrations/migrate until you have created your custom user model, otherwise Django will revert to its default User Model. Changing from Django's default user model to a custom user model is possible, but unsupported and prone to many errors. Do this first before anything else if that's what you want for your app. **NOTE:** I have already done this, but leaving it here for notes. So after setting up your local DB and ensuring that the .env database settings matches your local database settings, you should only need to run:

python manage.py migrate

to create the DB schemas locally

)

*** CREATING NEW PROJECT  (alreay completed, leaving for notes)***

create new Django project (make sure you are in dir you want project to be created):
django-admin startproject yourprojectname

within this directory, create a new file called `.env` and add all of the environment variables (get the values from me)

*** CREATING NEW SUPERUSER AND RUN LOCAL DEV SERVER ***

create your own admin superuser:

- activate env and run
  `python manage.py createsuperuser`
  (if you get a TTY error in Windows and you are using MINGW/git bash terminal, exit out and use Windows command prompt or Powershell and try it again)
- start Django dev server:
- set env DEV_MODE variable:
  DEV_MODE=True
- start Django dev server in terminal:
- linux:
  `DJANGO_SETTINGS_MODULE=main_project.dev_settings python manage.py runserver`
- windows (command prompt):

    `set DJANGO_SETTINGS_MODULE=main_project.dev_settings&& python -m manage runserver`

- windows (powershell):

  `$env:DJANGO_SETTINGS_MODULE = "main_project.dev_settings"; python -m manage runserver`

you should be able to access backend admin portal at
127.0.0.1:8000/api/admin

- you can now create apps (for models --users, tracks, artists, etc; make sure you are in project root directory when creating apps. After creating an app, make sure you register it by adding it to the main project's settings.py file INSTALLED_APPS dict)

`python manage.py startapp my_app_name`

To run vs code debugger:

- make sure you add your env's python interpreter executable path to the python interpreter in the command palette for VS Code
- In top level directory, add this launch.json file:

```

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Django",
            "type": "python",
            "request": "launch",
            "program": "/your/path/to/manage.py",
            "args": [
                "runserver"
            ],
            "django": true,
            "env": {
                "DJANGO_SETTINGS_MODULE": "main_project.dev_settings"
            },
            "justMyCode": true
        }
    ]
}
```

In main_project folder, create .env file
add these env vars:

DEV_DOMAIN=http://127.0.0.1:8000
DEV_MODE=True

If you were preveiously in production mode, stop all nginx and gunicorn servers and open
your browser's dev tools and clear all cache and cookie data:

sudo systemctl stop nginx
sudo systemctl stop gunicorn
sudo systemctl stop gunicorn.socket

*** PRODUCTION SIMULATION SERVER (https self-signed SSL certs) ***

TO START SIMULATED PROD SERVER
access site over https with self-signed ssl certs
(see servers_ssl_db_setup folder and complete those steps first if you haven't set up the servers locally in your machine yet):
set backend env DEV_MODE var:
DEV_MODE=False

restart nginx and gunicorn
sudo systemctl restart nginx
sudo systemctl restart gunicorn.socket
sudo systemctl restart gunicorn

access the backend API/admin page at:

whatever you named your hosts name in nginx/gnicorn ssl setup

After everything is working, you can begin developing and making changes to code.
After you have made a code change, restart servers to see updates:

reset nginx and gunicorn

sudo systemctl restart nginx
sudo systemctl restart gunicorn