diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7d2974ee..d7ae5058 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,8 +20,9 @@ Avec cette commande, tu clones le sith AE dans le dossier courant. ```bash cd Sith virtualenv --system-site-packages --python=python3 env -source env_sith/bin/activate +source env/bin/activate pip install -r requirements.txt +./manage runserver ``` Attention aux dépendances système, à voir dans le README.md diff --git a/README.md b/README.md index 776960b8..442b1fb9 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,29 @@ ## Sith AE +### Dependencies: +See requirements.txt + +You may need to install some dev libraries like `libmysqlclient-dev`, `libssl-dev`, `libjpeg-dev`, `python3-xapian`, or `zlib1g-dev` to install all the +requiered dependancies with pip. You may also need `mysql-client`. Don't also forget `python3-dev` if you don't have it +already. + +You can check all of them with: + +```bash +sudo apt install libmysqlclient-dev libssl-dev libjpeg-dev zlib1g-dev python3-dev libffi-dev python3-dev libgraphviz-dev pkg-config python3-xapian gettext +``` + +On macos, you will need homebrew + +```bash +brew install xapian +``` + +If it doesn't work it's because it need [this pull request](https://github.com/Homebrew/homebrew-core/pull/34835) to be validated. + +The development is done with sqlite, but it is advised to set a more robust DBMS for production (Postgresql for example) + ### Get started To start working on the project, just run the following commands: @@ -20,6 +43,8 @@ pip install -r requirements.txt To start the simple development server, just run `python3 manage.py runserver` +For more informations, check out the CONTRIBUTING.md file. + ### Logging errors with sentry To connect the app to sentry.io, you must set the variable SENTRY_DSN in your settings custom. It's composed of the full link given on your sentry project @@ -29,29 +54,6 @@ To connect the app to sentry.io, you must set the variable SENTRY_DSN in your se There is a Doxyfile at the root of the project, meaning that if you have Doxygen, you can run `doxygen Doxyfile` to generate a complete HTML documentation that will be available in the *./doc/html/* folder. -### Dependencies: -See requirements.txt - -You may need to install some dev libraries like `libmysqlclient-dev`, `libssl-dev`, `libjpeg-dev`, `python3-xapian`, or `zlib1g-dev` to install all the -requiered dependancies with pip. You may also need `mysql-client`. Don't also forget `python3-dev` if you don't have it -already. - -You can check all of them with: - -```bash -sudo apt install libmysqlclient-dev libssl-dev libjpeg-dev zlib1g-dev python3-dev libffi-dev python3-dev libgraphviz-dev pkg-config python3-xapian -``` - -On macos, you will need homebrew - -```bash -brew install xapian -``` - -If it doesn't work it's because it need [this pull request](https://github.com/Homebrew/homebrew-core/pull/34835) to be validated. - -The development is done with sqlite, but it is advised to set a more robust DBMS for production (Postgresql for example) - ### Collecting statics for production: We use scss in the project. In development environment (DEBUG=True), scss is compiled every time the file is needed. For production, it assumes you have already compiled every files and to do so, you need to use the following commands :