- Python 3
- foreman
Create a Python 3 virtual environment and install the requirements:
mkvirtualenv --python=$(which python3) sarahjaine.com
pip install -r requirements.txt
Create the database specified in .env, run the initial model migration, and create a super user:
createdb sarahjaine
foreman run python manage.py migrate
foreman run python manage.py createsuperuser
Use nvm to install the correct version of Node.js and install the front-end dependencies:
nvm install
npm install
Do an initial build of assets:
npm run build
First load the virtualenv:
workon sarahjaine.com
foreman start -f Procfile.dev
Procfile.dev defines the following processes:
- web: the Django development server
- static: the gulp watch process
foreman start -f Procfile.dev will start all of the processes at once. If you
want to run a specific process, you can specify it directly:
foreman start -f Procfile.dev web
When deployed to production or staging, the application and any other processes will be run as defined in the Procfile. You can run this file locally using foreman to launch the application the same way it will be run in production:
foreman start
You are highly encouraged to do this before finishing features to make sure the app runs as expected before it is deployed.
| Environment Variable | Description |
|---|---|
| DEBUG | True in development, False otherwise |
| SECRET_KEY | Set this to a different value in every environment |
| ALLOWED_HOSTS | comma separated list of allowed domains |
| DATABASE_URL | database config URI |
| SSLIFY_DISABLE | disables SSL check when True |
In addition to deploying the project, some additional steps are necessary for deployment to Heroku.
In order to build static assets, we'll include the nodejs buildpack in addition to the Python buildpack.
heroku buildpacks:set https://github.com/heroku/heroku-buildpack-python
heroku buildpacks:add --index 1 https://github.com/heroku/heroku-buildpack-nodejs
For more information, see Heroku's multiple buildpack guide.
heroku addons:create heroku-postgresql:hobby-basic
All projects should use HTTPS in production. Some projects will terminate on Heroku, others on CloudFront. Ask your system administrator if Heroku SSL is right for you.
heroku addons:create ssl:endpoint
Follow the SSL Endpoint documentation to upload the custom cert and finish configuration.