opmorgan / recipes-site

A simple website for family recipes

A simple website for family recipes, made with django.

Dependencies

• System-wide: docker, docker-compose, python3, django
• Python: See requirements.txt

To set up development environment

1. Create file .env, hidden from version control, which sets the variables POSTGRES_USER, POSTGRES_PASSWORD, POSTGRESS_DB, and SECRET_KEY
2. Run the docker container: sudo docker-compose up.
3. Create python virtual environment: python -m venv env
4. Enter python virtual environment: source env/bin/activate
5. Install required python packages: pip install -r requirements.txt
6. Make initial migrations: python manage.py migrate
7. Create an admin user for the local database: python manage.py createsuperuser
8. Start the development server: python manage.py runserver --settings base.settings.dev
9. Start the vite development server for js componenents: From the "frontend" directory, run npm run dev
10. Preview site in browser at localhost:8000

To make model changes and migrations

1. Change models (models.py)
2. Run python manage.py makemigrations to create migrations for those changes
3. Run python manage.py migrate to apply those changes to the database.

To deploy changes to production

1. In a development environment, push changes to the dev branch. To push frontend changes, run npm run build and then push the automatically generated changes.
2. On the production server, check out the dev branch (git checkout dev) and pull the latest changes (git pull).
3. Enter python virtual environment: source env/bin/activate
4. Run the production server: python3 manage.py runserver --settings base.settings.production
5. Collect static files (so that nginx will manage them): python3 manage.py collectstatic --settings base.settings.production
6. If models have changed, apply migrations: python3 manage.py migrate --settings base.settings.production
7. If everything looks good, check out the main branch on the production server (git checkout main) and merge changes from dev (git merge dev).