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

Quickstart

The easiest way to start a new Django project with Forge is to use the quickstart.py! It will prompt you along the way if you don't have certain things installed, but you should expect to have: Python 3, Poetry, Docker, and Git.

curl -sSL https://forgepackages.com/quickstart.py | python3 - my-project

What does the script do?

  • Create a new directory (mkdir my-project)
  • Set it up as a git repo (git init)
  • Add a default .gitignore
  • Install Forge using poetry
  • Copy the Forge project template into the new directory
  • Create a git pre-commit hook for your local repo
  • Run makemigrations for the default User and Team models

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

To deploy on Heroku, first make sure you have a Heroku account and the heroku CLI installed. Use the following command to set up everything you need for Heroku:

# Use `--help` for more options.
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)