feat: review backend and frontend
- update to the latest version of Java/SpringBoot - update to the latest version NuxtJS - add account/password update - add account creation - add account password reset - add bundle to regroup questions and add default questions on user creation - add bundle creation
This commit is contained in:
83
README.md
83
README.md
@@ -1,15 +1,32 @@
|
||||
# Boussole PLUSS
|
||||
|
||||
Le projet backend contient la partie backend de la Boussole PLUSS. Le projet frontend, le frontend communiquant avec le backend.
|
||||
## Contribuer à la Boussole
|
||||
Le projet actuel est prévu pour travailler sur le thème de la production locale.
|
||||
Cet outil peut servir à évaluer des collectifs sur d’autres thématiques. Vous êtes encouragé à y réfléchir et à y
|
||||
travailler. La licence AGPL version 3 prévoit un partage des améliorations que vous porterez à l’outil. Si vous
|
||||
désirez faire un fork de l’outil, contactez-nous : contact@apes-hdf.org
|
||||
|
||||
## Installation
|
||||
|
||||
En utilisant docker-compose:
|
||||
Le projet backend contient la partie backend de la Boussole PLUSS. Le projet frontend, le site web communiquant avec le backend.
|
||||
|
||||
|
||||
Copier/coller le fichier `.env_template` en `.env` et modifier les variables d'environnements.
|
||||
|
||||
En utilisant docker-compose :
|
||||
`docker-compose build` en modifiant au préalable l'argument BACKEND_BASE_URL du fichier
|
||||
docker-compose.yml pour spécifier l'URL sur laquelle pointera le backend.
|
||||
`docker-compose up` pour lancer le frontend et backend.
|
||||
|
||||
Exemple de configuration Nginx compatible avec le docker-compose de ce projet (URL_EXTERNE est à remplacer
|
||||
Au premier lancement, il faut initialiser la base de donnée. Pour ce faire :
|
||||
|
||||
- `docker-compose up -d database`
|
||||
- `docker exec database psql -U postgres -c "CREATE DATABASE pluss_db ENCODING UTF8" postgres`
|
||||
|
||||
En suite, les autres services peuvent être lancés avec `docker-compose up -d`. La base de données sera remplie automatiquement par le service backend.
|
||||
|
||||
Le site est accessible via le service `frontend`, dans cet exemple du docker-compose.yml, depuis http://localhost:8190.
|
||||
|
||||
Voici un exemple de configuration Nginx compatible avec le docker-compose de ce projet (URL_EXTERNE est à remplacer
|
||||
par l'URL publique) :
|
||||
|
||||
```
|
||||
@@ -45,60 +62,4 @@ server {
|
||||
}
|
||||
```
|
||||
|
||||
Ceci est un exemple à ne pas utiliser sur un environnement de production.
|
||||
|
||||
## Administration
|
||||
|
||||
Par la suite, `__URL__` est l'URL du backend, `__USER__` et `__PASSWORD__` le nom de compte et mot de passe à créer / utiliser.
|
||||
### Créer un nouveau compte
|
||||
```bash
|
||||
curl --location --request POST '__URL__/api/auth/signup' \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data-raw '{
|
||||
"username": "__USER__",
|
||||
"password": "__PASSWORD__"
|
||||
}'
|
||||
```
|
||||
|
||||
### Se connecter
|
||||
```bash
|
||||
curl --location --request POST '__URL__/api/auth/signin' \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data-raw '{
|
||||
"username": "__USER__",
|
||||
"password": "__PASSWORD__"
|
||||
}'
|
||||
```
|
||||
Cet appel renverra un token à réutiliser pour l'ensemble des requêtes. Par exemple :
|
||||
|
||||
```json
|
||||
{
|
||||
"token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJkZW1vIiwiaWF0IjoxNjY1NjY5NjUyLCJleHAiOjE2NjU2NzMyNTJ9.i426thZKL4-JvOt9ZeG2D1O6O-xlSiPoCMiKysHYzCkHVNrnxKetq8xKRNCTnbpLV-wagpOw2g-om34k2jtHIw",
|
||||
"refreshToken": "de73adcb-a5a8-4675-8bb3-5536651be0f9",
|
||||
"id": 11,
|
||||
"username": "demo"
|
||||
}
|
||||
```
|
||||
|
||||
### Afficher les balises (axe)
|
||||
```bash
|
||||
curl --location --request GET '__URL__/api/axes' \
|
||||
--header 'Authorization: Bearer TOKEN'
|
||||
```
|
||||
Le TOKEN est à remplacer par celui reçu.
|
||||
|
||||
### Ajouter une question à un axe
|
||||
```bash
|
||||
curl --location --request POST '__URL__/api/questions' \
|
||||
--header 'Authorization: Bearer TOKEN' \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data-raw '
|
||||
{
|
||||
"axe": "URL_BALISE_1",
|
||||
"label": "Question 1",
|
||||
"description": "Description .."
|
||||
}
|
||||
'
|
||||
```
|
||||
Il faut spécifier URL_BALISE_1 comme étant l'URL de la balise 1 récupérer dans la requête précédente.
|
||||
Par exemple : `__URL__/axes/1`
|
||||
Ceci est un exemple à ne pas utiliser sur un environnement de production.
|
Reference in New Issue
Block a user