v1.0 - Aurion Synchronizer

Merge pull request #13 from LBF38/development

.gitignore

@@ -1,2 +1,12 @@
 .env
-/node_modules
+/node_modules
+aurion.ics
+
+.DS_Store
+
+CalAurion-NG/node_modules/
+
+# server build
+build/
+
+CalAurion-NG/

README.md

@@ -7,11 +7,60 @@ Ainsi, le calendrier dans notre application de calendrier (sur téléphone ou au
 
 ## Installation
 
-Ce projet est principalement codé en JavaScript et utilise NodeJS.
+Ce projet est principalement codé en TypeScript et utilise NodeJS.
 Pour lancer un script JS, utiliser la commande :
 
-```nodejs
+```bash
 node [nom fichier].js
 ```
 
-Plus d'explications viendront plus tard dans le projet.
+Pour lancer un script TypeScript, utiliser la commande :
+
+```bash
+ts-node [nom fichier].ts
+```
+
+Pour lancer le serveur de développement, utiliser la commande :
+
+```bash
+pnpm dev
+```
+
+ou
+
+```bash
+pnpm run dev
+```
+
+> **Note**
+> Passage à `pnpm` plutôt que `npm` pour gérer les dépendances.
+
+*Plus d'explications viendront plus tard dans le projet.*
+
+## Roadmap
+
+- [ ] Backend
+  - [x] Connexion de l'utilisateur pour récup user token
+  - [x] Récupération des données à partir de l'api ENSTA Bretagne (AURION)
+  - [ ] Traitement et conversion au format ics
+    - [x] Génération d'un fichier ics
+    - [ ] Gérer les différences, les majs de calendrier, etc...
+  - [ ] Génération d'un lien automatique pour synchronisation avec calendrier
+  - [x] Gérer les erreurs ou alerter si problème.
+- [ ] Frontend
+  - [x] Site internet simple et facile d'utilisation
+  - [x] Interface de login de base (pour connexion ENSTA B)
+    - [x] username
+    - [x] password
+  - [ ] Passage à interface pour récup calendrier
+    - [x] V1
+      - [x] paramétrage des dates de la période à prendre
+      - [x] Interface pour visualisation des changements
+      - [x] Lien de téléchargement du fichier ics
+    - [ ] V2
+      - [ ] Lien de synchronisation directement
+        - [ ] la synchro se fait automatiquement en backend avec le calendrier de l'utilisateur (que le calendrier soit : google calendar, outlook, apple calendar, ...)
+- [ ] Vérification avant déploiement
+  - [ ] Vérif sécurité
+    - [ ] ne pas pouvoir accéder à la page après login si ne fonctionne pas.
+- [ ] Documentation du code et du projet

docs/README.md

@@ -0,0 +1,22 @@
+# Documentation de l'API et du projet
+
+Ce projet consiste à récupérer automatiquement les informations du site de l'ENSTA Bretagne (<https://formation.ensta-bretagne.fr>) pour récupérer le planning de l'utilisateur qui se connecte via le formulaire de la page principale.
+
+## Informations générales
+
+Parcours de l'utilisateur :
+
+- L'utilisateur se connecte via la page principale de mon serveur (`index`).
+  - Si tout fonctionne bien, il est redirigé vers une page pour choisir la période de planning qu'il veut récupérer. (`planning/pull`)
+  - Sinon, il est redirigé vers la page principale avec une explication de l'erreur (`index`).
+- L'utilisateur choisit la période de planning qu'il veut récupérer.
+  - Si tout fonctionne bien, il est redirigé vers une page pour récupérer un lien vers le fichier `ics` ou le télécharger. (`planning/download`)
+  - Sinon, il est redirigé vers la page précédente avec une explication de l'erreur (`planning/pull`).
+- L'utilisateur récupère le lien vers le fichier `ics` ou le télécharge.
+
+## Routes de l'API
+
+- `GET /` : Page principale du serveur.
+- `POST /planning/pull` : Récupère le planning de l'utilisateur.
+- `GET /planning/download` : Télécharge le fichier `ics` du planning de l'utilisateur.
+- `POST /login` : Connexion de l'utilisateur.