mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2024-11-22 09:36:52 +03:00
Update documentation for bare metal local development
- Mention the need for Redis if Celery is selected - Link to PostgreSQL & Redis download pages - Detail better how to set the environment - Improve internal links using Sphinx' :ref - Remove unused link
This commit is contained in:
parent
f60b6d464c
commit
6dd64ddd53
|
@ -9,24 +9,53 @@ Setting Up Development Environment
|
||||||
|
|
||||||
Make sure to have the following on your host:
|
Make sure to have the following on your host:
|
||||||
|
|
||||||
* virtualenv_;
|
* Python 3.6
|
||||||
* pip;
|
* PostgreSQL_.
|
||||||
* PostgreSQL.
|
* Redis_, if using Celery
|
||||||
|
|
||||||
First things first.
|
First things first.
|
||||||
|
|
||||||
#. `Create a virtualenv`_.
|
#. Create a virtualenv: ::
|
||||||
|
|
||||||
#. Activate the virtualenv you have just created.
|
$ python3 -m venv <virtual env path>
|
||||||
|
|
||||||
|
#. Activate the virtualenv you have just created: ::
|
||||||
|
|
||||||
|
$ source <virtual env path>/bin/activate
|
||||||
|
|
||||||
#. Install development requirements: ::
|
#. Install development requirements: ::
|
||||||
|
|
||||||
$ pip install -r requirements/local.txt
|
$ pip install -r requirements/local.txt
|
||||||
|
|
||||||
#. Create a new PostgreSQL database (note: if this is the first time a database is created on your machine you might need to alter a localhost-related entry in your ``pg_hba.conf`` so as to utilize ``trust`` policy): ::
|
#. Create a new PostgreSQL database using createdb_: ::
|
||||||
|
|
||||||
$ createdb <what you've entered as the project_slug at setup stage>
|
$ createdb <what you've entered as the project_slug at setup stage>
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
if this is the first time a database is created on your machine you might need to alter
|
||||||
|
a localhost-related entry in your ``pg_hba.conf`` so as to utilize ``trust`` policy, see the
|
||||||
|
`postgres documentation`_ for more details.
|
||||||
|
|
||||||
|
#. Set the environment variables for your database(s): ::
|
||||||
|
|
||||||
|
$ export DATABASE_URL=postgres://<project_slug>
|
||||||
|
# Optional: set broker URL if using Celery
|
||||||
|
$ export CELERY_BROKER_URL=redis://localhost:6379/0
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Check out the :ref:`settings` page for a comprehensive list of the environments variables.
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
|
||||||
|
To help setting up your environment variables, you have a few options:
|
||||||
|
|
||||||
|
* create an ``.env`` file in the root of your project and define all the variables you need in it.
|
||||||
|
Then you just need to have ``DJANGO_READ_DOT_ENV_FILE=True`` in your machine and all the variables
|
||||||
|
will be read.
|
||||||
|
* Use a local environment manager like `direnv`_
|
||||||
|
|
||||||
#. Apply migrations: ::
|
#. Apply migrations: ::
|
||||||
|
|
||||||
$ python manage.py migrate
|
$ python manage.py migrate
|
||||||
|
@ -35,8 +64,11 @@ First things first.
|
||||||
|
|
||||||
$ python manage.py runserver 0.0.0.0:8000
|
$ python manage.py runserver 0.0.0.0:8000
|
||||||
|
|
||||||
.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
|
.. _PostgreSQL: https://www.postgresql.org/download/
|
||||||
.. _`Create a virtualenv`: https://virtualenv.pypa.io/en/stable/userguide/
|
.. _Redis: https://redis.io/download
|
||||||
|
.. _createdb: https://www.postgresql.org/docs/current/static/app-createdb.html
|
||||||
|
.. _postgres documentation: https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html
|
||||||
|
.. _direnv: https://direnv.net/
|
||||||
|
|
||||||
|
|
||||||
Setup Email Backend
|
Setup Email Backend
|
||||||
|
@ -69,9 +101,7 @@ For instance, one of the packages we depend upon, ``django-allauth`` sends verif
|
||||||
|
|
||||||
Now you have your own mail server running locally, ready to receive whatever you send it.
|
Now you have your own mail server running locally, ready to receive whatever you send it.
|
||||||
|
|
||||||
.. _`Download the latest MailHog release`: https://github.com/mailhog/MailHog/releases
|
.. _`Download the latest MailHog release`: https://github.com/mailhog/MailHog
|
||||||
.. _`properly configured`: https://docs.djangoproject.com/en/dev/topics/email/#smtp-backend
|
|
||||||
|
|
||||||
|
|
||||||
Console
|
Console
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
@ -88,11 +118,8 @@ In production, we have Mailgun_ configured to have your back!
|
||||||
Sass Compilation & Live Reloading
|
Sass Compilation & Live Reloading
|
||||||
---------------------------------
|
---------------------------------
|
||||||
|
|
||||||
If you’d like to take advantage of live reloading and Sass compilation you can do so with a little bit of preparation_.
|
If you’d like to take advantage of live reloading and Sass compilation you can do so with a little
|
||||||
|
bit of preparation, see :ref:`sass-compilation-live-reload`.
|
||||||
|
|
||||||
.. _preparation: https://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html
|
|
||||||
|
|
||||||
|
|
||||||
Summary
|
Summary
|
||||||
-------
|
-------
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
.. _sass-compilation-live-reload:
|
||||||
|
|
||||||
Sass Compilation & Live Reloading
|
Sass Compilation & Live Reloading
|
||||||
=================================
|
=================================
|
||||||
|
|
||||||
|
|
1
{{cookiecutter.project_slug}}/.gitignore
vendored
1
{{cookiecutter.project_slug}}/.gitignore
vendored
|
@ -333,6 +333,7 @@ tags
|
||||||
[Ss]cripts
|
[Ss]cripts
|
||||||
pyvenv.cfg
|
pyvenv.cfg
|
||||||
pip-selfcheck.json
|
pip-selfcheck.json
|
||||||
|
.env
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
### Project template
|
### Project template
|
||||||
|
|
Loading…
Reference in New Issue
Block a user