diff options
author | Patryk Zawadzki <patrys@room-303.com> | 2016-08-30 22:33:11 +0200 |
---|---|---|
committer | Patryk Zawadzki <patrys@room-303.com> | 2016-08-30 22:33:11 +0200 |
commit | 9eb83950b716ec10f9f4895d5fd59b7bb2ccb17c (patch) | |
tree | 7a98854c5bb05868ff08f2f1a159f675caea373a /docs | |
parent | 5cff0cd1c41a88226f2b410e5e0683f624bf8e5c (diff) | |
download | saleor-frontend-9eb83950b716ec10f9f4895d5fd59b7bb2ccb17c.tar.gz saleor-frontend-9eb83950b716ec10f9f4895d5fd59b7bb2ccb17c.tar.bz2 saleor-frontend-9eb83950b716ec10f9f4895d5fd59b7bb2ccb17c.zip |
Mention Docker and CircleCI in docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/deploy.rst | 41 | ||||
-rw-r--r-- | docs/development.rst | 57 |
2 files changed, 67 insertions, 31 deletions
diff --git a/docs/deploy.rst b/docs/deploy.rst index c21847fc..769ac1bf 100644 --- a/docs/deploy.rst +++ b/docs/deploy.rst @@ -1,46 +1,25 @@ Deployment ========== +.. _docker: + Docker ------ +You will need to install Docker first. -Local prerequisites -******************* - -You will need to install Docker and -`docker-compose <https://docs.docker.com/compose/install/>`_ before -performing the following steps. - -Usage -***** - -1. Build ``Saleor`` with ``docker-compose`` - - .. code:: - - $ docker-compose build - +Before building the image make sure you have all of the front-end assets prepared for production: -2. Prepare the database - - .. code:: - - $ docker-compose run web python manage.py migrate - $ docker-compose run web python manage.py populatedb --createsuperuser - - The ``--createsuperuser`` switch creates an admin account for - ``admin@example.com`` with the password set to ``admin``. - - -3. Run ``Saleor`` +.. code:: - .. code:: + $ npm run build-assets + $ python manage.py collectstatic - $ docker-compose up +Then use Docker to build the image: +.. code:: -By default, the application is configured to listen on port ``8000``. + $ docker build -t mystorefront . Heroku diff --git a/docs/development.rst b/docs/development.rst index 18f9af7a..19bd17d7 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -73,3 +73,60 @@ To do so you can use `Tox <https://tox.readthedocs.io/en/latest/>`_: .. code:: bash $ tox + + +Continuous integration +---------------------- + +The storefront ships with a working `CircleCI <https://circleci.com/>`_ configuration file. +To use it log into your CircleCI account and enable your repository. + + +Docker +------ + +Using Docker to build software allows you to run and test code without having to worry about external dependencies such as cache servers and databases. + +.. warning:: + + The following setup is only meant for local development. + See :ref:`docker` for production use of Docker. + + +Local prerequisites +******************* + +You will need to install Docker and +`docker-compose <https://docs.docker.com/compose/install/>`_ before +performing the following steps. + + +Usage +***** + +1. Build the containers using ``docker-compose`` + + .. code:: + + $ docker-compose build + + +2. Prepare the database + + .. code:: + + $ docker-compose run web python manage.py migrate + $ docker-compose run web python manage.py populatedb --createsuperuser + + The ``--createsuperuser`` switch creates an admin account for + ``admin@example.com`` with the password set to ``admin``. + + +3. Run the containers + + .. code:: + + $ docker-compose up + + +By default, the application is started in debug mode, will automaticall reload code and is configured to listen on port ``8000``. |