notes_development.md

Notes - Development

• Setup
  • Init workspace
  • Prepare Django project
  • Start and stop the server
• Project
  • Prepare for test or new git version
  • Logging
• Helpful things
  • Python
    • Virtual environment (venv)
    • Save (working) pip packages in project venv
  • Django
    • Reset Migrations
    • Generate a new SECRET_KEY
  • Sqlite
    • Backup & Restore
  • nginx
    • Create self signed certificate
  • Docker
    • Inspect running Docker containers

Setup

Init workspace

# Clone the source code
git clone https://github.com/tigion/htwd-project-se-team-management.git

# Switch to project folder
cd htwd-project-se-team-management

# Use default config (or change something)
cp .env.template .env

# Create and activate Python virtual environment
python3 -m venv .venv
source .venv/bin/activate

# Install required Python packages
pip3 install -r src/backend/requirements.txt

Prepare Django project

# detect and collect model changes
python3 manage.py makemigrations

# migrate collected model changes to database
python3 manage.py migrate

# create superuser
# - Only needed for new database
# - Is part in the Docker compose.yaml
python3 manage.py createsuperuser

# collect and save static files
# - They are later delivered directly via nginx
python3 manage.py collectstatic

Start and stop the server

• Django development server:

  # - URI: localhost:8000
  # Start
  cd htwd-project-se-team-management/src/backend/
  python3 manage.py runserver 0.0.0.0:8000
  # Stop: CTRL+C

• Gunicorn server:

  # - URI: localhost:8000
  cd htwd-project-se-team-management/src/backend/
  gunicorn config.wsgi:application -c gunicorn.conf.py
  # Stop: CTRL+C

• Docker:

  # - URI: localhost
  cd htwd-project-se-team-management/
  (sudo) docker compose up -d
  # Stop
  (sudo) docker compose down

Project

Prepare for test or new git version

1. Remove sensitive data or outsource them to the .env file.
2. Prepare Django project:

   python3 manage.py makemigrations
   python3 manage.py migrate
   python3 manage.py collectstatic

3. Test the project
4. Freeze (working) pip package versions:

   pip freeze -l > requirements.freeze.txt

Warning

For final deployment use the Deployment checklist:

python3 manage.py check --deploy.

Logging

When the project is running with Docker, log files from Django and nginx are stored under:

• docker/logs/django/: django.log
• docker/logs/nginx/: access.log, error.log

Helpful things

Python

Virtual environment (venv)

# Create
python3 -m venv .venv

# Activate
source .venv/bin/activate

# Install pip packages
pip3 install -r requirements.txt

# Update pip packages in venv only
pip freeze --require-virtualenv | cut -d'=' -f1 | xargs -n1 pip install -U

# Deactivate
deactivate

# Remove
deactivate
rm -rf .venv

Save (working) pip packages in project venv

pip freeze -l > requirments.freeze.txt

Django

Reset Migrations

Warning

This will delete the database! Relevant data must be backed up.

rm db.sqlite3
rm app/migrations/00*.py
rm poll/migrations/00*.py
rm team/migrations/00*.py
python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py createsuperuser

Generate a new SECRET_KEY

python3 -c 'from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())'

Sqlite

Backup & Restore

# Backup all tables
sqlite3 db.sqlite3
sqlite> .output db_dump_all.sql
sqlite> .dump
sqlite> .exit

# Backup table <table>
sqlite3 db.sqlite3
sqlite> .output db_dump_<table>.sql
sqlite> .dump <table>
sqlite> .exit

# Restore table: <table>
sqlite3 db.sqlite3
.read db_dump_<table>.sql
.exit

nginx

Create self signed certificate

sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout localhost.key -out localhost.crt

Docker

Inspect running Docker containers

docker ps
docker exec -it <Container-ID or Name> /bin/sh