2020-11-06 10:44:25 +00:00
|
|
|
Contribute
|
|
|
|
|
==========
|
2020-11-05 16:51:59 +00:00
|
|
|
|
|
|
|
|
Contributions are welcome!
|
|
|
|
|
|
2020-11-06 10:44:25 +00:00
|
|
|
Unit tests
|
|
|
|
|
----------
|
|
|
|
|
|
2020-11-05 16:51:59 +00:00
|
|
|
To run the tests, you just need to run `tox`. Everything must be green before patches get merged.
|
|
|
|
|
|
2020-11-06 10:44:25 +00:00
|
|
|
Style
|
|
|
|
|
-----
|
|
|
|
|
|
2020-11-05 16:51:59 +00:00
|
|
|
We use `black` to format our code. Please apply `black` on your patches before submiting them.
|
|
|
|
|
|
2020-11-06 10:44:25 +00:00
|
|
|
Development environment
|
|
|
|
|
-----------------------
|
|
|
|
|
|
2020-11-10 16:52:52 +00:00
|
|
|
To try a development environment, you can run the docker image and then open https://127.0.0.1:5000 to access the canaille server.
|
|
|
|
|
Two dummy clients are available at https://127.0.0.1:5001 and https://127.0.0.1:5002
|
2020-11-05 16:51:59 +00:00
|
|
|
You can then connect with user *admin* and password *admin* to access an admin account, or user *user* and password *user* for a regular one.
|
|
|
|
|
|
2020-11-06 10:44:25 +00:00
|
|
|
.. code-block:: console
|
|
|
|
|
|
2020-11-10 16:52:52 +00:00
|
|
|
cd demo
|
|
|
|
|
./run.sh
|
|
|
|
|
# or 'docker-compose up' if you prefer docker
|
