/django-boilerplate

A raw django boilerplate with async background tasks support

Primary LanguagePythonMIT LicenseMIT

Open Issues Forks Stars Maintained Made with Python Open Source Love Built with Love Follow Me Telegram

django-boilerplate

📒 Index

🔰 About

A raw django boilerplate with async background tasks support

🔧 Development

Install Docker Engine

  • Install Docker Engine from here

Install Docker Compose

  • Install Docker Compose from here

Setup Environment Variables

  1. Move inside api directory

  2. Copy the .example.env file and make a new file .env

  3. Setup variables

Local setup

  1. Move inside api directory and install venv

    python3 -m venv .venv

  2. Activate virtual environment

    source ./.venv/bin/activate/

  3. Install requirements

    pip install -r requirements.txt

Start-up the docker containers

docker compose up

Run migrations

Open another terminal, go to same directory and run

docker compose exec api ./manage.py migrate

🌟 Credit/Acknowledgment

Aman Verma

Credits goes to me

🔒 License

LICENSE