Skip to content

Commit

Permalink
[Documentation] The .env.local is required to run docker-compose… (#557)
Browse files Browse the repository at this point in the history
[Documentation] The .env.local is required to run docker-compose build
  • Loading branch information
rexhepberlajolli committed Oct 19, 2019
2 parents 32c7830 + 2cd48f0 commit b187c12
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ To download, install and start the local server for development, simply run::

git clone git@github.com:djangopackages/djangopackages.git
cd djangopackages
docker-compose -f dev.yml build
cp .env.local.example .env.local
docker-compose -f dev.yml build
docker-compose -f dev.yml up

Then point your browser to http://localhost:8000 and start hacking!
Expand Down
30 changes: 22 additions & 8 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,43 @@ Main instructions

These instructions install Django Packages on your computer, using Docker.

Git clone the project and build Docker container
------------------------------------------------
Git clone the project
---------------------

Clone the Django Packages project using git, and build the project using docker-compose::
Clone the Django Packages project using git:

.. code-block:: bash
git clone git@github.com:djangopackages/djangopackages.git
cd djangopackages
docker-compose -f dev.yml build
Set up the development environment
----------------------------------

In order to run the project, you need to add a file called ``.env.local``. The file holds all the configurable settings and secrets to run properly.
In order to run the project, you first need to add a file called ``.env.local``.
The file holds all the configurable settings and secrets to run properly.

There's an example file available. To get started, copy the file::
There's an example file available. To get started, copy the file:

.. code-block:: bash
cp .env.local.example .env.local
Build Docker container
----------------------

Now build the project using docker-compose:

.. code-block:: bash
docker-compose -f dev.yml build
Running the project
-------------------

To start the project, run:

.. sourcecode:: bash
.. code-block:: bash
docker-compose -f dev.yml up
Expand All @@ -47,7 +59,9 @@ Then point your browser to http://localhost:8000 and start hacking!
Give yourself an admin account on the site
------------------------------------------

Create a Django superuser for yourself, replacing joe with your username/email::
Create a Django superuser for yourself, replacing joe with your username/email:

.. code-block:: bash
docker-compose -f dev.yml run django python manage.py createsuperuser --username=joe --email=joe@example.com
Expand Down

0 comments on commit b187c12

Please sign in to comment.