Update readme with .env variable details.

ministryofjustice · Jan 26, 2024 · 72469d1 · 72469d1
1 parent b63bf2b
commit 72469d1
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/.env.example b/.env.example
@@ -1,7 +1,7 @@
 # Django Development Variables
 DEBUG=1
 SECRET_KEY=foo
-DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1] .service.justice.gov.uk
+DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1]
 
 # Catalogue Variables
 CATALOGUE_TOKEN=mycatalogtoken

diff --git a/README.md b/README.md
@@ -3,8 +3,10 @@
 You will need npm (for javascript dependencies) and poetry (for python dependencies).
 
 1. Run `poetry install` to install python dependencies
-2. Set environment variables CATALOGUE_URL and CATALOGUE_TOKEN (TODO: add dotenv support)
-3. Run `poetry run python manage.py runserver`
+2. Copy  `.env.example` to `.env`.
+3. You wil need to obtain an access token from Datahub catalogue and populate the  `CATALOGUE_TOKEN` var in .env to be able to retrieve search data.
+https://datahub.apps-tools.development.data-platform.service.justice.gov.uk/settings/tokens
+4. Run `poetry run python manage.py runserver`
 
 Run `npm install` and then `npm run sass` to compile the stylesheets.