README.md 784 Bytes
Newer Older
Skia's avatar
Skia committed
1
## Sith AE
Skia's avatar
Skia committed
2

Skia's avatar
Skia committed
3
### Get started
Skia's avatar
Skia committed
4 5 6 7 8

To start working on the project, just run the following commands:

    git clone https://ae-dev.utbm.fr/ae/Sith.git
    cd Sith
9 10 11
    virtualenv --clear --python=python3 env_sith
    source env_sith/bin/activate
    pip install -r requirements.txt
Skia's avatar
Skia committed
12
    ./manage.py setup
Skia's avatar
Skia committed
13

Skia's avatar
Skia committed
14
To start the simple development server, just run `python3 manage.py runserver`
Skia's avatar
Skia committed
15

Skia's avatar
Skia committed
16
### Generating documentation
Skia's avatar
Skia committed
17

Skia's avatar
Skia committed
18 19
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.
Skia's avatar
Skia committed
20

Skia's avatar
Skia committed
21
### Dependencies:
Skia's avatar
Skia committed
22
  * Django 1.8
Skia's avatar
Skia committed
23 24 25 26
  * Pillow

The development is done with sqlite, but it is advised to set a more robust DBMS for production (Postgresql for example)

Skia's avatar
Skia committed
27