This project provides a useful starter dough that you can use to bake a delicious Django cake! It's extremely opinionated, just like Django, and is mostly just something I'll use for my own projects -- Although, you're welcome to use it if you want!
What's included?
- A basic
Pipfilewith some useful packages and scripts. - A
docker-composefile that allows hot-seat reloading and includes a PostgreSQL database that will automatically hook up to your Django app. gunicornfor launching your webapp with several workers and threads. Makes it more scalable, basically.nginxfor serving your static files. All static files must be withinstatic/folder. In order to get static files in django admin section working please runpython manage.py collectstatic --noinputin your project's directory. It will copy necessary static files from Django app installed in virtual environment.- A
.gitignorewith some common ignores in it. - One Django app with nothing in it.
Okay, now how do I do this?
Make sure docker and docker-compose are installed, then just run docker-compose up in the root folder. This will launch your app, and the files will all be hot-reloadable, so you can just write code and refresh the browser.
This will set up a database too, but the database will not persist any data.
Docker is scary, do I have to use it?
Well, no. Here's how you would use it without Docker.
First, you'll need PostgreSQL running somewhere. You'll also need to make sure pipenv is installed. Then create a new file called .env in the root folder, and fill it with something like this:
DEBUG=1
SECRET_KEY=yellowpolkadotbikini
POSTGRES_USER=lemon
POSTGRES_PASSWORD=coolpassworddude
POSTGRES_HOST=localhost
POSTGRES_PORT=5432Now to start your app, just run pipenv install to set everything up, and then pipenv run start to run the app.