From 393526bc4795be176d2a86944e77904c0085a497 Mon Sep 17 00:00:00 2001 From: Jonathan Thompson Date: Mon, 27 Apr 2020 02:31:46 +0000 Subject: [PATCH] Clarify the installation steps for local setup Added a link to Cookiecutter as a prerequisite. Added an installation command for cookiecutter-django. Added a command for git init. The precommit install fails unless you have a git repo. This should make it easier for a newcomer to get things configured. --- docs/developing-locally.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/developing-locally.rst b/docs/developing-locally.rst index 4f70414cb..dc146c232 100644 --- a/docs/developing-locally.rst +++ b/docs/developing-locally.rst @@ -12,6 +12,7 @@ Make sure to have the following on your host: * Python 3.8 * PostgreSQL_. * Redis_, if using Celery +* Cookiecutter_ First things first. @@ -23,9 +24,14 @@ First things first. $ source /bin/activate +#. Install cookiecutter-django + + $ cookiecutter gh:pydanny/cookiecutter-django :: + #. Install development requirements: :: $ pip install -r requirements/local.txt + $ git init # A git repo is required for pre-commit to install $ pre-commit install .. note:: @@ -78,6 +84,7 @@ or if you're running asynchronously: :: .. _PostgreSQL: https://www.postgresql.org/download/ .. _Redis: https://redis.io/download +.. _CookieCutter: https://github.com/cookiecutter/cookiecutter .. _createdb: https://www.postgresql.org/docs/current/static/app-createdb.html .. _initial PostgreSQL set up: http://suite.opengeo.org/docs/latest/dataadmin/pgGettingStarted/firstconnect.html .. _postgres documentation: https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html