2015-11-19 07:47:24 +00:00
|
|
|
## Sith AE
|
2015-11-19 07:45:21 +00:00
|
|
|
|
2016-01-29 15:29:24 +00:00
|
|
|
### Get started
|
2015-11-19 07:45:21 +00:00
|
|
|
|
|
|
|
|
To start working on the project, just run the following commands:
|
|
|
|
|
|
|
|
|
|
git clone https://ae-dev.utbm.fr/ae/Sith.git
|
|
|
|
|
cd Sith
|
2015-12-03 19:29:07 +00:00
|
|
|
virtualenv --clear --python=python3 env_sith
|
|
|
|
|
source env_sith/bin/activate
|
|
|
|
|
pip install -r requirements.txt
|
2015-12-04 15:13:20 +00:00
|
|
|
./manage.py setup
|
2015-11-19 07:45:21 +00:00
|
|
|
|
2016-01-29 15:29:24 +00:00
|
|
|
To start the simple development server, just run `python3 manage.py runserver`
|
2015-11-24 09:55:15 +00:00
|
|
|
|
2016-01-29 15:29:24 +00:00
|
|
|
### Generating documentation
|
2015-11-24 09:55:15 +00:00
|
|
|
|
2016-01-29 15:29:24 +00:00
|
|
|
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.
|
2015-11-19 07:45:21 +00:00
|
|
|
|
2016-01-29 15:29:24 +00:00
|
|
|
### Dependencies:
|
2015-12-04 15:13:20 +00:00
|
|
|
* Django 1.8
|
2016-01-29 15:29:24 +00:00
|
|
|
* Pillow
|
|
|
|
|
|
|
|
|
|
The development is done with sqlite, but it is advised to set a more robust DBMS for production (Postgresql for example)
|
|
|
|
|
|
2015-11-19 07:45:21 +00:00
|
|
|
|
