Django Boilerplate Project

A boilerplate project for Django to fast initialization.

All backend code follows PEP8 style guidelines.

Useful Links

• pycodestyle Error Codes
• flake8 Error Codes

Getting Started

Steps

• Clone/pull/download this repository.
• Create virtual environment and install dependencies.
• Configure the env variables. Use src/.env for development. For production, set them in the OS.
• Rename the project.

#Syntax
python manage.py rename <current_project_name> <new_project_name>

#Example
python manage.py rename current_project my_project

5. Generate Secret Key Use this key as your SECRET_KEY. Replace SECRET_KEY in 'src/.env'.

• Method 1

python manage.py shell

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

• Method 2

python -c "from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())"

Create Virtual Environment and Install Dependencies

python -m venv venv
venv\Scripts\activate
pip install -r requirements.txt
pip freeze > requirements.txt

Key Dependencies

• Django: A Python based web framework.
• pillow: A library to manage images in Django Apps.
• django-debug-toolbar: To manage debugging in development mode.
• psycopg2: for managing postgres db
• dj-database-url: for postgres db url

Dependencies for heroku

gunicorn: Server whitenoise: Simplified static file serving

Important Package Versions

• python==3.9
• Django==3.2

Optional Dependencies

• django-crispy-forms - A Library to integrate Django forms with Bootstrap.
• django-allauth - Used for authentication.
• django-countries - Used to list countries.

Installation

pip install django-crispy-forms, django-allauth, django-countries

Included in requirements.txt - external installation not required.

Database Setup

Development

SQLite database is used for development. It is configured automatically by Django.

Production

With Postgres, create a database named testdb createdb testdb

Make sure to include the database credentials in env_file.py

Running the server

From the project directory to run the server, execute:

python manage.py migrate
python manage.py runserver

Important Note

• Uncomment '.env' inside .gitignore so that .env file is not uploaded in the repository.
• Edit '.vscode/settings.json' ss per your choices.
• You must generate a new secret key for your project.

Production Note

• Make sure to set environmental variable DEBUG=False.

Author

Himel Das

Acknowledgement

This boilerplate is an extension of the boilerplate by justdjango. I studied the YouTube videos on this topic by JustDjango YouTube channel while creating this boilerplate. Thanks to justdjango for creating such an amazing boilerplate and step by step tutorial.

• Django Project Boilerplate by justdjango
• How to Create a Boilerplate for Django Project

Note

For special commands and detailed note refer to the following links:

• COMMANDS.md
• NOTE.md
• HEROKU.md