README.md 4.16 KB
Newer Older
Skia's avatar
Skia committed
1 2
[![pipeline status](https://ae-dev.utbm.fr/ae/Sith/badges/master/pipeline.svg)](https://ae-dev.utbm.fr/ae/Sith/commits/master)
[![coverage report](https://ae-dev.utbm.fr/ae/Sith/badges/master/coverage.svg)](https://ae-dev.utbm.fr/ae/Sith/commits/master)
Sli's avatar
Sli committed
3
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
Sli's avatar
Sli committed
4
[![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://ae-dev.zulipchat.com)
Skia's avatar
Skia committed
5

Skia's avatar
Skia committed
6
## Sith AE
Skia's avatar
Skia committed
7

8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
### 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)

Skia's avatar
Skia committed
31
### Get started
Skia's avatar
Skia committed
32 33 34

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

35 36 37 38 39 40 41 42
```bash
git clone https://ae-dev.utbm.fr/ae/Sith.git
cd Sith
virtualenv --system-site-packages --python=python3 env
source env/bin/activate
pip install -r requirements.txt
./manage.py setup
```
Skia's avatar
Skia committed
43

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

Sli's avatar
Sli committed
46 47
For more informations, check out the CONTRIBUTING.md file.

Sli's avatar
Sli committed
48 49 50 51
### 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

Skia's avatar
Skia committed
52
### Generating documentation
Skia's avatar
Skia committed
53

Skia's avatar
Skia committed
54 55
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
56

Sli's avatar
Sli committed
57 58
### Collecting statics for production:

Sli's avatar
Sli committed
59 60
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 : 

61
```bash
Sli's avatar
Sli committed
62 63
./manage.py collectstatic # To collect statics
./manage.py compilestatic # To compile scss in those statics
Sli's avatar
Sli committed
64
```
Skia's avatar
Skia committed
65

Skia's avatar
Skia committed
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
### Misc about development

#### Controlling the rights

When you need to protect an object, there are three levels:
  * Editing the object properties
  * Editing the object various values
  * Viewing the object

Now you have many solutions in your model:
  * You can define a `is_owned_by(self, user)`, a `can_be_edited_by(self, user)`, and/or a `can_be_viewed_by(self, user)`
    method, each returning True is the user passed can edit/view the object, False otherwise.   
    This allows you to make complex request when the group solution is not powerful enough.    
    It's useful too when you want to define class-wide permissions, e.g. the club members, that are viewable only for
    Subscribers.
  * You can add an `owner_group` field, as a ForeignKey to Group.  Second is an `edit_groups` field, as a ManyToMany to
    Group, and third is a `view_groups`, same as for edit.

Finally, when building a class based view, which is highly advised, you just have to inherit it from CanEditPropMixin,
CanEditMixin, or CanViewMixin, which are located in core.views. Your view will then be protected using either the
appropriate group fields, or the right method to check user permissions.

Skia's avatar
Skia committed
88 89
#### Counting the number of line of code

90 91 92
```bash
sudo apt install cloc
cloc --exclude-dir=doc,env .
Skia's avatar
Skia committed
93
```
Skia's avatar
Skia committed
94

Skia's avatar
Skia committed
95 96 97 98 99 100 101 102
#### Updating doc/SYNTAX.md

If you make an update in the Markdown syntax parser, it's good to document
update the syntax reference page in `doc/SYNTAX.md`. But updating this file will
break the tests if you don't update the corresponding `doc/SYNTAX.html` file at
the same time.  
To do that, simply run `./manage.py markdown > doc/SYNTAX.html`,
and the tests should pass again.
Skia's avatar
Skia committed
103 104