hoang-himself / pip-pip

The Forum Center Backend

Clone the repo

• HTTPS

git clone https://github.com/Smithienious/pip-pip.git -b dev --depth 1

• SSH

git clone [e-mail]:Smithienious/pip-pip.git -b dev --depth 1

Change working directory

cd pip-pip

(Recommended) Initialize a virtual environment

python -m venv --upgrade-deps ./.venv
source ./.venv/bin/activate

Install tools and dependencies

sudo apt update
sudo apt install -y postgresql
pip install -r requirements.txt

First-time setup

Configure PostgreSQL server

Read the .env file

Migrate the database

python manage.py makemigrations
python manage.py makemigrations master_db
python manage.py migrate

Running the server

python manage.py <host>:<port>

<host> defaults to 127.0.0.1
<port> defaults to 8000

FAQ

JWT token

On login, the access token is returned in the response body. Take this token, put it in the header according to this format

'Authorization': 'JWT <token>'

The space behind JWT is important.

SECRET_KEY and JWT_KEY

By default, this program reads the keys from shell environment variables, i.e. export SECRET_KEY=<key>

You can generate the keys using the Django shell at python manage.py shell

from django.core.management.utils import get_random_secret_key
get_random_secret_key()

Utility functions

Clear database

sudo -u postgres psql \
  -c "DROP DATABASE tfc;" \
  -c "CREATE DATABASE tfc;" \
  -c "GRANT ALL PRIVILEGES ON DATABASE tfc TO tfc_admin;"

Clean cache and migrations file, with creating default superuser

find . -type f -name "*.py[co]" -delete
find . -type d -name "__pycache__" -delete
find . -depth -type d -name ".mypy_cache" -exec rm -r {} +
find . -depth -type d -name ".pytest_cache" -exec rm -r {} +
find . -path "*/migrations/*.py" -not -name "__init__.py" -not -path "*/db/*" -delete

python manage.py makemigrations
python manage.py migrate
python manage.py collectstatic --no-input

python manage.py createsuperuser_with_password \
--email '[e-mail]' \
--phone '0999999999' \
--password 'iamowner' \
--preserve --no-input