1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
|
.. _development:
Development
===========
Prerequisites
-------------
- `docker <https://docs.docker.com/>`_
Installation
------------
.. code-block:: bash
$ git clone https://github.com/jrobichaud/django-structlog.git
$ cd django-structlog
$ pip install -r requirements.txt
$ pre-commit install
Start Demo App
--------------
.. code-block:: bash
$ docker compose up --build
- ``runserver_plus`` server: http://127.0.0.1:8000/
- ``WSGI`` server: http://127.0.0.1:8001/
- ``ASGI`` server: http://127.0.0.1:8002/
Use ``RabbitMQ`` broker instead of ``redis``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash
$ docker compose -f ./docker-compose.yml -f ./docker-compose.amqp.yml up --build
Building, Serving and Testing the Documentation Locally
-------------------------------------------------------
.. code-block:: bash
$ docker compose -p django-structlog-docs -f docker-compose.docs.yml up --build
Serving on http://127.0.0.1:8080
|