You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
mailu/docs/contributors/environment.rst

40 lines
961 B
ReStructuredText

Development environment
=======================
Docker containers
-----------------
The development environment is quite similar to the production one. You should always use
the ``testing`` version when developping. Simply uncomment the ``build`` directive on
containers that you are working on and run:
.. code-block:: bash
docker-compose build
whenever you want to re-build them.
Web administration
------------------
The administration Web interface requires a proper dev environment that can easily be setup using ``virtualenv`` (make sure you are using Python 3) :
.. code-block:: bash
cd admin
virtualenv .
source bin/activate
pip install -r requirements.txt
You can then export the path to the development database (use four slashes for absolute path):
.. code-block:: bash
export SQLALCHEMY_DATABASE_URI=sqlite:///path/to/dev.db
And finally run the server with debug enabled:
.. code-block:: bash
python manage.py runserver