Django Rocket#

A Django SaaS boilerplate

Django Rocket is an almost-ready-to-launch boilerplate framework powered by Cookiecutter.

It was initially built to allow me to launch my SaaS projects without having to copy-paste common code, so expect the design decisions and integrations to be targeted for this purpose.

Requirements#

To get started, you need to install the dependencies

You can install them via pip

pip install cookiecutter==2.1.1 django==4.1.4

Note

Django Rocket works with other versions of Cookiecutter and Django, but it lacks extensive test coverage so there may be small errors. For now it’s better to stick to the mentioned versions.

Usage#

To build your project with cookiecutter

cookiecutter gh:ErnestoFGonzalez/djangorocket

You’ll be prompted to enter some information

project_name [My Project]:
project_slug [my_project]:

Output#

Running this command will create a directory called my_project inside the current folder. Inside my_project, you’ll have the initial project structure:

my_project
├── requirements
│  ├── requiremens-dev.txt
│  ├── requiremens-docs.txt
│  ├── requiremens-linting.txt
│  ├── requiremens-testing.txt
│  └── requirements.txt
├── src
│  ├── my_project
│  │  ├── auth
│  │  ├── billing
│  │  ├── utils
│  │  ├── __init__.py
│  │  ├── asgi.py
│  │  ├── celery.py
│  │  ├── context_processors.py
│  │  ├── model_loaders.py
│  │  ├── settings.py
│  │  ├── urls.py
│  │  ├── views.py
│  │  └──wsgi.py
│  ├── static
│  ├── tailwind_theme
│  ├── templates
│  └── manage.py
├── .env
├── .env.example
├── requiremens.txt
└── runtime.txt

For a deep dive, see Initial project structure.

Start developing#

In order to get started with your development there are a few things you need to do first:

  • Install project requirements

  • Create and connect a Postgres database

  • Run database migrations

  • Create and connect a Redis instance

  • Set up a Stripe project and product

  • Set up Sign in with Google

  • Install Tailwind dependencies

Go to Development for a step-by-step guide.

License#

Django Rocket is distributed under the Apache License 2.0. You can read the full license here.