cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2025-02-18 12:30:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Simplify docs and un-deprecate the part that's still valid.

Browse Source
This commit is contained in:
Audrey Roy Greenfeld 2015-10-03 16:21:08 -07:00
parent 6258583fb1
commit 606b026a8c
1 changed files with 17 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/developing-locally-docker.rst
View File

@ -4,6 +4,7 @@ Getting Up and Running with Docker
.. index:: Docker .. index:: Docker
The steps below will get you up and running with a local development environment. The steps below will get you up and running with a local development environment.
All of these commands assume you are in the root of your generated project.
Prerequisites Prerequisites
-------------- --------------
@ -17,11 +18,6 @@ If you don't already have these installed, you can get them at:
* https://github.com/docker/toolbox/releases * https://github.com/docker/toolbox/releases
Go to the Root of your Project
------------------------------
All of these commands assume you are in the root of your generated project.
Create the Machine Create the Machine
------------------- -------------------
@ -33,15 +29,6 @@ Create the Machine
name them accordingly. Instead of 'dev1' you might have 'dev2', 'myproject', name them accordingly. Instead of 'dev1' you might have 'dev2', 'myproject',
'djangopackages', et al. 'djangopackages', et al.
Make the new machine the active unit
-------------------------------------
This tells our computer that all future commands are specifically for the just
created machine. Using the ``eval`` command we can switch machines as needed.
::
$ eval "$(docker-machine env dev1)"
Get the IP Address Get the IP Address
-------------------- --------------------
@ -122,17 +109,8 @@ Example:
$ docker-compose run django python manage.py createsuperuser $ docker-compose run django python manage.py createsuperuser
Working With Your Container
Deprecated -----------------------------
==========
**Note:** This segment of documentation is being kept in this location as part of our documentation transition process.
The steps below will get you up and running with a local development environment. We assume you have the following installed:
* docker
* docker-compose
Open a terminal at the project root and run the following for local development:: Open a terminal at the project root and run the following for local development::
@ -146,9 +124,22 @@ And then run::
$ docker-compose up $ docker-compose up
To migrate your app and to create a superuser, run:: To migrate your app and to create a superuser, run::
$ docker-compose run django python manage.py migrate $ docker-compose run django python manage.py migrate
$ docker-compose run django python manage.py createsuperuser $ docker-compose run django python manage.py createsuperuser
Other Useful Tips
------------------
Make a machine the active unit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This tells our computer that all future commands are specifically for the dev1 machine.
Using the ``eval`` command we can switch machines as needed.
::
$ eval "$(docker-machine env dev1)"