Ultimate Django3.2 Template

Just a big starting point for any backend project

Guideline

• Goal
• Repo Features
• Configurations
• Development usage
• Testing usage
• Production usage
• License
• Todo
• Bugs

Goal

This project main goal is to provide a way to deploy django applications by using docker along with nginx, gunicorn and letsencrypt and much more features a backed developer needs.

Repo Features

• Latest LTS Django3.2

Latest LTS included 3.2.x and needed requirements

• Git

python gitignore and README with license

• Docker File

Latest Python image dockerfile prod/dev and dockerignore

• Docker Compose

Docker compose prod/dev and minimum setup for django and db included,with volumes and network

• Nginx + Gunicorn

included nginx setup with gunicorn as serving service and file configs for production

• Django env

enviroment sample file and setup

• Hints and Files

Sample files and hints all over the template for giving more pace

• Black

Reformating your codes to standard projects

• Travis and Flake8

Included with travis.yml configuration file for test purposes.plus included Flake8 and config files.

• Preconfigured

Preconfigured settings.py for email,db,static,media etc.

Configurations

• Static & Media Directories

STATIC_ROOT and STATIC_URL and same for media configurations with STATICFILES_DIRS

• Template Directories

Genral templates directory for root

• Site Framework and Sitemaps + robots

Siteframework as in site_id configs with robots.txt and sample sitemaps

• Database Configs

Database configuration for production with postgresql and volume directory in data

• Email Configs

Email configurations for dev and prod as in env file

• Message Configs

Message and warnings configuration for notification handelings

• Hints and Files

Sample files and hints all over the template for more giving more pace

• TestCase

Hints for TestCases and sample files for an app

• Security

Security tags for https and redirections,HSTS,Cookie and other headers

Development usage

You'll need to have Docker installed. It's available on Windows, macOS and most distros of Linux.

If you're using Windows, it will be expected that you're following along inside of WSL or WSL 2.

That's because we're going to be running shell commands. You can always modify these commands for PowerShell if you want.

Clone this repo anywhere you want and move into the directory:

git clone https://github.com/AliBigdeli/Ultimate-Django3.2-Template.git

Enviroment Varibales are included in docker-compose.yml file for debugging mode and you are free to change commands inside:

services:
  app:
    command: sh -c "python manage.py makemigrations && python manage.py migrate && python manage.py runserver 0.0.0.0:8000"
    environment:      
      - DEBUG=1

Build everything:

The first time you run this it's going to take 5-10 minutes depending on your internet connection speed and computer's hardware specs. That's because it's going to download a few Docker images and build the Python + requirements dependencies.

docker-compose up --build

Now that everything is built and running we can treat it like any other Django app.

Note:

If you receive an error about a port being in use? Chances are it's because something on your machine is already running on port 8000. then you have to change the docker-compose.yml file according to your needs.

Check it out in a browser:

Visit http://localhost:8000 in your favorite browser.

Testing Usage

running all at the same time:

docker-compose run --rm app sh -c " black -l 79 && flake8 && python manage.py test" -v core:/app

Production usage

License

MIT.

Todo

• fix production composefile
• connect repo to travis ci
• add development usage doc
• add test usage doc
• add encryptions
• add production usage doc

Bugs

Feel free to let me know if something needs to be fixed. or even any features seems to be needed in this repo.