Skip to content

Commit aceb482

Browse files
committed
MAJ des readme
1 parent a7e6917 commit aceb482

File tree

2 files changed

+18
-47
lines changed

2 files changed

+18
-47
lines changed

README.md

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,6 @@
1-
# Template DataForGood
1+
# Balance tes haters
22

3-
This file will become your README and also the index of your
4-
documentation.
3+
## Documentation et installation
54

6-
# Contributing
7-
8-
9-
## Installation backend
10-
11-
- [Installation de Python](#installation-de-python)
12-
13-
Ce projet utilise [uv](https://docs.astral.sh/uv/) pour la gestion des dépendances Python. Il est préréquis pour l'installation de ce projet.
14-
15-
Une fois installé, il suffit de lancer la commande suivante pour installer la version de Python adéquate, créer un environnement virtuel et installer les dépendances du projet.
16-
17-
```bash
18-
cd backend
19-
uv sync
20-
```
21-
22-
A l'usage, si vous utilisez VSCode, l'environnement virtuel sera automatiquement activé lorsque vous ouvrirez le projet. Sinon, il suffit de l'activer manuellement avec la commande suivante :
23-
24-
```bash
25-
source .venv/bin/activate
26-
```
27-
28-
## Lancer les precommit-hook localement
29-
30-
[Installer les precommit](https://pre-commit.com/)
31-
32-
pre-commit run --all-files
33-
34-
## Utiliser Tox pour tester votre code
35-
36-
tox -vv
5+
- [Extension navigateur](./browser-extension/readme.md)
6+
- [Backend](./backend/readme.md)
Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
1-
# Template DataForGood
2-
3-
This file will become your README and also the index of your
4-
documentation.
5-
6-
# Contributing
7-
1+
# Backend Balance tes haters
82

93
## Installation
104

11-
- [Installation de Python](#installation-de-python)
12-
135
Ce projet utilise [uv](https://docs.astral.sh/uv/) pour la gestion des dépendances Python. Il est préréquis pour l'installation de ce projet.
146

157
Une fois installé, il suffit de lancer la commande suivante pour installer la version de Python adéquate, créer un environnement virtuel et installer les dépendances du projet.
@@ -24,12 +16,21 @@ A l'usage, si vous utilisez VSCode, l'environnement virtuel sera automatiquement
2416
source .venv/bin/activate
2517
```
2618

27-
Ou alors, utilisez la commande `uv run ...` (au lieu de `python ...`) pour lancer un script Python. Par exemple:
19+
## Création de la base de données
2820

29-
```bash
30-
uv run pipelines/run.py run build_database
21+
Nécessite un serveur de base de données PostgreSQL
22+
23+
- configurer les paramètres d'accès à la base de données dans le fichier [configuration.yml](configuration.yml)
24+
- lancer la commande:
25+
```
26+
alembic upgrade head
3127
```
3228

29+
## Lancement du backend
30+
31+
```
32+
fastapi dev server.py
33+
```
3334

3435
## Lancer les precommit-hook localement
3536

@@ -39,4 +40,4 @@ uv run pipelines/run.py run build_database
3940

4041
## Utiliser Tox pour tester votre code
4142

42-
tox -vv
43+
tox -vv

0 commit comments

Comments
 (0)