cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2024-11-26 11:34:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

Clarify the installation steps for local setup

Browse Source 
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.
This commit is contained in:
Jonathan Thompson 2020-04-27 02:31:46 +00:00 committed by GitHub
parent 6b71a3c8c2
commit 393526bc47
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/developing-locally.rst
View File

@ -12,6 +12,7 @@ Make sure to have the following on your host:
* Python 3.8 * Python 3.8
* PostgreSQL_. * PostgreSQL_.
* Redis_, if using Celery * Redis_, if using Celery
* Cookiecutter_
First things first. First things first.
@ -23,9 +24,14 @@ First things first.
$ source <virtual env path>/bin/activate $ source <virtual env path>/bin/activate
#. Install cookiecutter-django
$ cookiecutter gh:pydanny/cookiecutter-django ::
#. Install development requirements: :: #. Install development requirements: ::
$ pip install -r requirements/local.txt $ pip install -r requirements/local.txt
$ git init # A git repo is required for pre-commit to install
$ pre-commit install $ pre-commit install
.. note:: .. note::
@ -78,6 +84,7 @@ or if you're running asynchronously: ::
.. _PostgreSQL: https://www.postgresql.org/download/ .. _PostgreSQL: https://www.postgresql.org/download/
.. _Redis: https://redis.io/download .. _Redis: https://redis.io/download
.. _CookieCutter: https://github.com/cookiecutter/cookiecutter
.. _createdb: https://www.postgresql.org/docs/current/static/app-createdb.html .. _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 .. _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 .. _postgres documentation: https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html