README.md

<%= project_name %>

A Django REST API<% if (prod_branch) { %> with a React SPA frontend<% } %> scaffolded using generator-django-rest.

Before getting started, make sure you've installed:

To get started with development, set up the dependencies:

./scripts/install.sh

And start the development server:

./scripts/start.sh

If you prefer Docker, use:

docker-compose run cli migrate
docker-compose run cli createsuperuser
docker-compose up

You can easily deploy the app on Heroku:

<% if (prod_branch) { %> [](https://heroku.com/deploy?template=<%= git_url %>/tree/prod) <% } else { %> <% } %>

and then trigger new deployments by running:

./scripts/deploy.sh

More information in HACKING.md.