From da540a2abb535b83f4bf8a3fb6261ec53befaf96 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Thu, 9 Jun 2022 09:18:10 +0100 Subject: [PATCH] Add basic README instructions --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index f1b0571..4a5aed5 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ # Website + +## Installation + +1. Create a virtual environment +2. `pip install -r requirements.txt` +3. Create [`.env` file](#env-file) +4. `./manage.py runserver` + +### `.env` file + +Local development secrets are stored in a `.env` file. + +These values are required for the application to load + +- `DEBUG` set to `false` +- `SECRET_KEY` set to [something](https://django-secret-key-generator.netlify.app/) semi-random