Skip to content

Commit

Permalink
📝 [#408] update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
annashamray committed May 31, 2024
1 parent 696db69 commit dd94a90
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 19 deletions.
8 changes: 4 additions & 4 deletions README.NL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,10 @@ Quickstart

.. code:: bash
$ wget https://raw.githubusercontent.com/maykinmedia/objects-api/master/docker-compose-quickstart.yml -O docker-compose.yml
$ docker-compose -f docker-compose-qs.yml up -d
$ docker-compose exec web src/manage.py loaddata demodata
$ docker-compose exec web src/manage.py createsuperuser
$ wget https://raw.githubusercontent.com/maykinmedia/objects-api/master/docker-compose.yml
$ docker compose up -d --no-build
$ docker compose exec web src/manage.py loaddata demodata
$ docker compose exec web src/manage.py createsuperuser
2. In de browser, navigeer naar ``http://localhost:8000/`` om de admin en de
API te benaderen.
Expand Down
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,10 @@ Quickstart

.. code:: bash
$ wget https://raw.githubusercontent.com/maykinmedia/objects-api/master/docker-compose-quickstart.yml -O docker-compose-qs.yml
$ docker-compose -f docker-compose-qs.yml up -d
$ docker-compose exec web src/manage.py loaddata demodata
$ docker-compose exec web src/manage.py createsuperuser
$ wget https://raw.githubusercontent.com/maykinmedia/objects-api/master/docker-compose.yml
$ docker compose up -d --no-build
$ docker compose exec web src/manage.py loaddata demodata
$ docker compose exec web src/manage.py createsuperuser
2. In the browser, navigate to ``http://localhost:8000/`` to access the admin
and the API.
Expand Down
22 changes: 11 additions & 11 deletions docs/installation/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Quickstart
==========

A simple ``docker-compose-quickstart.yml`` file is available to get the APIs
A simple ``docker-compose.yml`` file is available to get the APIs
up and running in minutes. This file has some convenience settings to get
started quickly and these should never be used for anything besides testing:

Expand Down Expand Up @@ -31,31 +31,31 @@ Objecttypes API

.. code:: shell
$ wget https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/docker-compose-quickstart.yml -O docker-compose-qs.yml
$ wget https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/docker-compose.yml
.. tab:: Windows Powershell 3

.. code:: shell
PS> wget https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/docker-compose-quickstart.yml -O docker-compose-qs.yml
PS> wget https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/docker-compose.yml
3. Start the Docker containers:

.. code:: shell
$ docker-compose -f docker-compose-qs.yml up -d
$ docker compose up -d --no-build
4. Import a demo set of objecttypes:

.. code:: shell
$ docker-compose exec web src/manage.py loaddata demodata
$ docker compose exec web src/manage.py loaddata demodata
5. Create a superuser

.. code:: shell
$ docker-compose exec web src/manage.py createsuperuser
$ docker compose exec web src/manage.py createsuperuser
Objects API
Expand All @@ -76,32 +76,32 @@ Objects API

.. code:: shell
$ wget https://raw.githubusercontent.com/maykinmedia/objects-api/master/docker-compose-quickstart.yml -O docker-compose-qs.yml
$ wget https://raw.githubusercontent.com/maykinmedia/objects-api/master/docker-compose.yml
.. tab:: Windows Powershell 3

.. code:: shell
PS> wget https://raw.githubusercontent.com/maykinmedia/objects-api/master/docker-compose-quickstart.yml -O docker-compose-qs.yml
PS> wget https://raw.githubusercontent.com/maykinmedia/objects-api/master/docker-compose.yml
3. Start the Docker containers:

.. code:: shell
$ docker-compose -f docker-compose-qs.yml up -d
$ docker compose -f docker-compose-qs.yml up -d --no-build
4. Import a demo set of objects (linking to the demo objecttypes):

.. code:: shell
$ docker-compose exec web src/manage.py loaddata demodata
$ docker compose exec web src/manage.py loaddata demodata
5. Create a superuser

.. code:: shell
$ docker-compose exec web src/manage.py createsuperuser
$ docker compose exec web src/manage.py createsuperuser
6. Retrieve an object via the Objects API in your webbrowser:
Expand Down

0 comments on commit dd94a90

Please sign in to comment.