.. _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