installation.md 5.26 KB
Newer Older
1
2
3
4
5
6
7
Installation
=======

## Locale

Petit guide pour installer proprement cette application `django` et pouvoir contribuer.

Florent Chehab's avatar
Florent Chehab committed
8
9
10
11
12
### Base de données
L'application est « agnostique » au type de base de donnée employée. Alors qu'il fallait au départ forcément PostgreSQL pour tirer partie des fonctionnalités de stockage des documents JSON, ils sont 
aujourd'hui stockés sous forme de texte car aucune requête n'aurait besoin de les parcourir ; ainsi, seul des champs par défaut de django sont employés.

#### SQlite
13
Pour utiliser SQlite comme SGBD, il suffit de commenter le bloc qui concerne Postgresql dans le fichier de configuration visible ici : `./backend/general_app/settings/development.py` :
Florent Chehab's avatar
Florent Chehab committed
14
15

```python
16
17
18
19
20
21
22
23
24
25
    DATABASES = {
        'default': {
            'ENGINE': 'django.db.backends.postgresql_psycopg2',
            'NAME': 'outgoing',
            'USER': 'outgoing',
            'PASSWORD': 'outgoing',
            'HOST': '127.0.0.1',
            'PORT': '5432',
        }
    }
Florent Chehab's avatar
Florent Chehab committed
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
```
et de décommenter celui-ci :
```python
    ## Sqlite
    # PROJECT_DIR = os.path.abspath(os.path.dirname(__file__))
    # DATABASES = {
    #     'default': {
    #         'ENGINE': 'django.db.backends.sqlite3',
    #         'NAME': os.path.join(PROJECT_DIR, '../database.db'),
    #     }
    # }
```
La base de donnée sera alors stockée à la racine du projet dans le fichier `database.db`.

Si vous avez choisi cette option, vous pouvez sauter la partie sur postgreSQL.
41

Florent Chehab's avatar
Florent Chehab committed
42
#### postgreSQL
43

Florent Chehab's avatar
Florent Chehab committed
44
##### Installation
45

Florent Chehab's avatar
Florent Chehab committed
46
L'installation de `postgreSQL` est un plus gros challenge. Pour ce faire, utiliser ~~Google~~ DuckDuckGo.
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

Vous devez faire en sorte que `postgreSQL` soit accessible en local, c'est suffisant :

- Dans le fichier `postgresql.conf` (disponible en standard sous linux dans le dossier `/var/lib/pgsql/data/` après installation), décommentez/modifiez les lignes :
```conf
listen_addresses = 'localhost'
port = 5432		
```
- Dans le fichier `pg_hba.conf` (disponible en standard sous linux dans le dossier `/var/lib/pgsql/data/` après installation), ajoutée la ligne : 
```conf
host    all             all             127.0.0.1/32            trust
``` 

**Penser à relancer `postgreSQL` après ces changements _- et profitez-en pour activer le lancement automatique au démarrage si vous le souhaitez_.**

**Les contributions sont les bienvenues pour compléter cette partie d'installation/configuration de base.**


Florent Chehab's avatar
Florent Chehab committed
65
##### Initialisation
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

Pour un fonctionnement simplifié avec ce projet il faut procéder aux changement suivants.

```bash
su - postgres
```
_(Si vous avez un problème de mot de passe, contourner le problème : `sudo su - postgres`)_

Puis ouvrez l'interface en ligne de commande postgres : 

```bash
psql
```
Si vous ne voyez pas `postgres=#` c'est qu'il y a un problème, vérifier votre installation.

Créer un utilisateur correspondant à votre utilisateur/login classique dans postgre :

```sql
84
85
CREATE USER outgoing;
ALTER USER outgoing WITH PASSWORD 'outgoing';
86
87
88
89
``` 
Donner lui le droit de créer des bases de données (utile lors des tests en local) :

```sql
90
ALTER USER outgoing CREATEDB;
91
92
93
94
95
```

Créer une base de données qui lui sera associée :

```sql
96
97
CREATE DATABASE outgoing;
GRANT ALL on DATABASE outgoing to outgoing;
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
```
Sortez de `psql` (`\q`) et retrouver votre utilisateur normal (`CRTL` + `D`).

À ce stade, si vous tappez dans votre console :

```bash
psql -d <login>
```
Vous devez accéder à votre base de données sans soucis. 

_Si vous êtes arrivés jusque là, c'est tout bon !_


### virtualenv

Afin d'avoir des environnements reproductibles il est **fortement** suggéré d'utiliser un environnement virtuel pour ce projet.

(Ce projet est développé sur `python-3.6`)

```bash
118
python3.6 -m venv ./env
119
120
121
122
123
```

Cet environnement virtuel doit être **systématiquement** activé lorsque vous travaillez sur ce projet :

```bash
124
source ./env/bin/activate
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
```
Les lignes de votre console doivent alors commencez par `(<nom-du-venv>)`.


_Pour le désactiver, faîtes : `deactivate`_.

### git

Il ne vous reste plus qu'à cloner le projet :
```bash
git clone git@gitlab.utc.fr:chehabfl/outgoing_rex.git
cd outgoing_rex
```
(Il va de soit qu'il faut savoir installer/utiliser `git` pour ce projet...)


### C'est parti

Activer votre environnement virtuel (voir plus haut). Puis installer les dépendances :

```bash
pip install -r requirements.txt 
```

Téléchargez les dépendances `npm` nécessaires :

```bash
npm i
```

_Migrez_ la base de donnée :
```bash
./manage.py migrate
```

Florent Chehab's avatar
Florent Chehab committed
160
161
162
163
164
165
_Initialisez_ les révisions:
```bash
./manage.py createinitialrevisions
```
_NB: cette opération (en plus de `./manage.py makemigrations` et de la précédente) est à faire à chaque fois que vous rajoutez/modifier un model._

166
167
168
169
170
171
172
_Collectez_ les éléments statistiques :
```bash
./manage.py collectstatic
```

_Checkez_ le système :
```nash
173
make check_backend
174
175
176
```

```bash
177
make test_backend
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
```

Tout ce qu'il y a jusqu'ici **doit** fonctionner. :smile:


_Il ne vous reste plus qu'à lancer le serveur et à contribuer :_
```bash
./manage.py runserver
```

## Django

Si vous n'avez jamais travailler avec Django, un tutoriel [s'impose](https://tutorial.djangogirls.org/fr/django_start_project/) ! 

## Déploiement _externe_

194
À ce jour, le déploiement est réalisé sur un petit vps [outgoing-utc.floflo.ch](outgoing-utc.floflo.ch)