README 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. The COIN project
  2. ================
  3. `Coin` is Illyse's Information System, designed to managed subscribers.
  4. It is written in Django, and makes an heavy use of LDAP (for
  5. authentication, and to store configuration information).
  6. It currently only works with python2, because `python-ldap` is (as of
  7. 2013) not compatible with python3.
  8. Quickstart
  9. ==========
  10. Get yourself a virtualenv. On Debian, install `python-virtualenv`. On
  11. Archlinux, the package is called `python2-virtualenv`, and you must
  12. replace the `virtualenv` command with `virtualenv2` in the following.
  13. To create the virtualenv (the first time):
  14. virtualenv ~/tmp/venv-illyse
  15. To activate the virtualenv (you need to do this each time you work on
  16. the project):
  17. . ~/tmp/venv-illyse/bin/activate
  18. Install dependencies. On Debian, you will probably need the
  19. `python-dev`, `libldap-dev` and `libsasl2-dev` packages. Then run:
  20. pip install -r requirements.txt
  21. You should now be able to run `python manage.py` (within the
  22. virtualenv, obviously) without error.
  23. More information
  24. ================
  25. For the rest of the setup (database, LDAP), see
  26. https://www.illyse.org/projects/ils-si/wiki/Mise_en_place_environnement_de_dev