Prerequisites

The following items are required in order for this template to work.

Note

There are scripts to install what you need for mac based operating systems automatically.

Dependencies

• node:

  • npm

  • yarn

  • webpack

• python3, although pyenv is recommended to manage versions:

  • cookiecutter

• git

• bash (WSL2 or Cygwin recommended for windows users)

• postgres

• terraform Used with Heroku for our CI

• poetry virtual environment/package manager

• direnv handles activating your virtual env when you enter the project directory

Environment Configuration

There is also a certain amount of environmental configuration that must be done in order for the above dependencies and the below template to work.

Note

If you have a setup guide/a setup process that works for windows or a particular linux distro, please add it below for the benefit of future developers. If you use a specific, non-standard shell (not bash or zsh or similar), please call that out in your instructions as well.

macOS

To install on a mac based operating system, you can use the install script to setup everything.

Run the following script block to get setup:

git clone git@github.com:Lightmatter/generic-django-conf.git
./generic-django-conf/scripts/mac_intel_install.sh

It’s recommended that you read the output of this script to ensure everything went smoothly, particularly if you are using Apple silicone (M1-based-mac).

Windows

Dependencies

• You will need to install Poetry (which requires python 3.10 or greater at the moment), (Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python3 - n.b. if you are using a bash shell, you should run the version of this command in the macOS section above

  • In order for poetry to run on the correct python version, you will want to make sure that python3 resolves to python 3.10 in your shell

Not macOS (including Windows)

Dependencies

• You will need to install direnv, platform specific installation instructions are available here

Before you create any projects with this template

• Ensure that your git is properly setup with your username and email in order for the initial commit to have the correct log.

• Project names must be composed of lowercase alphanumeric characters only, with no spaces or special characters.