Add contributors documentations
This commit is contained in:
39
docs/contributors/environment.rst
Normal file
39
docs/contributors/environment.rst
Normal file
@@ -0,0 +1,39 @@
|
||||
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
|
||||
Reference in New Issue
Block a user