Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
amandine-sahl committed Jul 7, 2023
1 parent 7720751 commit 09c0dde
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 6 deletions.
41 changes: 35 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,54 @@ Elle permet aux visiteurs d'un portail Geotrek Rando de réserver des places pou
événements.
Une interface d'administration est disponible pour gérer les réservations.


La gestion de l'authentification est sans mot de passe et fonctionne avec des liens envoyés par email.

Schéma simplifié du fonctionnement pour le grand public
## Interface grand public
**fonctionnalités principales**
* S'inscrire à une animation
* Confirmer son inscription
* Annuler son inscription
* Visualiser ses inscriptions


**Schéma simplifié du fonctionnement pour le grand public**
![Fonctionnement pour le grand public](docs/images/schema_grand_public.png)

## Interface administrateur
**fonctionnalités principales**
* Voir la liste des animations
* Gérer les inscriptions (visualisation/ajout/modification/annulation/export)
* Envoyer un email d'annulation en cas d'annulation de l'animation
* Exporter des bilans


**Schéma simplifié du fonctionnement pour les administrateurs**
Schéma simplifié du fonctionnement pour les administrateur
![Fonctionnement pour l'interface d'administrateur](docs/images/schema_admin.png)


# Installation et configuration
L'application n'est pas indépendante, elle repose sur la gestion des événements dans geotrek-admin et partage la même base de données.

Elle est composée de deux éléments :
* Fichier permettant d'ajouter le lien de réservation dans Geotrek-rando (non obligatoire)
* Application à proprement parlée

**Schéma générale de l'architecture**
![Archi Geotrek](docs/images/architecture_generale.png)


## Déploiement

Les instructions se trouvent à `docs/deploiement.md` et dans les READMEs `backend/README.md` et `front-vite/README.md`.



## Configuration

* `backend/config/config.py`
* `front-vite/public/config/config.js`
* `front-vite/public/page_accueil.md`
* `front-vite/public/page_info_admin.md`
* `front-vite/public/page_reservation.md`

## Déploiement

Les instructions se trouvent à `docs/deploiement.md` et dans les READMEs `backend/README.md` et `front-vite/README.md`.
* `front-vite/public/page_reservation.md`
Binary file added docs/images/architecture_generale.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 09c0dde

Please sign in to comment.