An opinionated boilerplate for your Django projects.

• Env Variables Manager: Django Environ
• Package manager: Poetry
• Database: PostgreSQL
• Task Queue: Celery with Redis
• Testing: PyTest
• Logging: Sentry
• Python Code Formatter: Black
• Static File Storage: AWS S3 or Digital Ocean Spaces
• Dev Orchestration: Docker & Docker Compose
• Static File Compiler: Webpack
• JS lint: ESLint
• Style lint: Stylelint

This is a guide on how to use this repo and save hours of boring configuration.

Instead of running django-admin startproject to start your new project, clone this repo in a directory of your choosing

git clone [email protected]:fceruti/django-starter-project.git <new-directory>

At this point you may either

1. Start a clean git repo by removing the .git directory and then running git init.
2. Receive patches and updates of this repo by modifying .git/config and switch [remote "origin"] for [remote "upstream"], and then add your own origin by running git remote add origin <your_repo>.

Following the 12 Factor App Guide, we will configure our app by setting the configuration variables in the environment. To do that, just create a file named .env in the root of the project and django-environ will pick it up and populate our settings.

You may use the example file as a starting point:

cp .env.example .env

I'll call this database django_db for the purposes of this guide, but you can call it whatever you want. Just watch out for careless copy-pasting.

Now run

poetry run migrate

You have two choices, either you turn every service on your own or you use docker-compose

We need to override DATABASE_URL environment variable inside of the Docker containers to connect directly to your host machine. Create a file called .env.docker with the following content:

DATABASE_URL=postgres://<user>@host.docker.internal:5432/django_db

• user is the user on your host machine that has access to postgres in this case.

Now we are ready to start the project.

docker-compose up

Visit http://127.0.0.1:8000 and you'll see your site up and running 🧘‍♀️

First of all, install pyenv so you can use the specified python version in .python-version file. Then, install poetry, which is a package manager replacement for pip. Now install all the project's dependencies with

poetry install

Make sure you have redis-server running and finally on 3 separate consoles run:

server

poetry run worker

worker

poetry run server

webpack

cd assets
npm install
npm run dev

Visit http://127.0.0.1:8000 and you'll see your site up and running 🧘‍♀️

Here are a few commands that may come in handy

These shortcuts are at your disposal:

To compile your static files, you need to have npm installed and all the local dependencies (run npm install). Then can execute the following commands

These environment variables can be provided to configure your project.

Documentation

Nowadays, my go-to editor is VSCode, so here's a template for .vscode/settings.json:

{
  // Editor
  "editor.formatOnSave": true,

  "files.exclude": {
    "**/__pycache__": true,
    "**/.pytest_cache": true,
    "**/*.egg-info": true
  },

  // Search
  "search.exclude": {
    "**/.git": true,
    "**/.vscode": true,
    "**/node_modules": true,
    "**/static": true,
    "**/media": true,
    "**/logs": true,
    "**/tmp": true,
    "**/locale": true
  },
  "search.showLineNumbers": true,

  // Python
  "python.venvPath": "<env_path>",
  "python.envFile": "${workspaceFolder}/.env",
  "python.jediEnabled": false,

  // Linting
  "python.linting.enabled": true,
  "python.linting.pylintEnabled": true,
  "python.linting.flake8Enabled": true,
  "python.formatting.provider": "black",
  "python.linting.pylintArgs": [
    "--load-plugins",
    "pylint_django",
    "--rcfile",
    "setup.cfg"
  ],

  // Eslint
  "eslint.options": {
    "configFile": ".eslintrc.json"
  },
  "eslint.nodePath": "assets/node_modules",
  "eslint.workingDirectories": ["assets/"],
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },

  // Stylelint
  "css.validate": false,
  "less.validate": false,
  "scss.validate": false
}

To fill the python.venvPath run poetry show -v to see the path to your virtual environment.