These docs are a work-in-progress and are currently undergoing a major rewrite!

Django + Forge Quickstart

1. Start a new local project

The Forge Quickstart will step you through creating a new project with our starter template. You'll need Python 3, Poetry, Docker, and Git.

# (Terminal)
curl -sSL https://forgepackages.com/quickstart.py | python3 - my-project

2. Create a GitHub repo

Once you have a new local project working, you can create an empty GitHub repo, then commit and push.

3. Deploy to Heroku

To deploy on Heroku, first make sure you have a Heroku account and the Heroku CLI installed. You can create everything you need on Heroku with our forge heroku shortcut:

# (Terminal)
forge heroku create <heroku-app-name> --team <heroku-team-name>

After you run the command, you'll need to connect your new Heroku app to your GitHub repo using your browser (it will print out a link for you to use).

  1. Find/authorize your GitHub repo
  2. Check the "Wait for CI to pass before deploy" box, and click "Enable Automatic Deploys"
  3. Click the "Deploy Branch" button to test a deploy (normally it will deploy when you push a new commit)

4. Go build!

At this point you should have completely functional environments for local development and production deployment. And that's a big part of what Forge is designed to help with.

From here, remember that at it's core, you just have a Django app. So the Django documentation is still your friend and you won't find Forge docs for the standard Django features.

Anything we've added or have opinions on are documented here:

Let us know if you have any questions or suggestions, and good luck!