https://github.com/vexcited/odm-2024
My submission to the Worldskills regionals 48th edition @ France, Nouvelle-Aquitaine.
https://github.com/vexcited/odm-2024
olympiades-des-metiers web-technologies
Last synced: 5 months ago
JSON representation
My submission to the Worldskills regionals 48th edition @ France, Nouvelle-Aquitaine.
- Host: GitHub
- URL: https://github.com/vexcited/odm-2024
- Owner: Vexcited
- Created: 2024-10-17T15:19:42.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-11-15T22:27:52.000Z (5 months ago)
- Last Synced: 2024-11-15T23:23:29.585Z (5 months ago)
- Topics: olympiades-des-metiers, web-technologies
- Language: TypeScript
- Homepage:
- Size: 15.1 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Participation ODM 2024 - Régionales de France
## Techstack
- [SolidStart](https://start.solidjs.com), framework fullstack basé sur SolidJS, utilise Vinxi, Vite et Nitro en interne
- [UnoCSS](https://unocss.dev), framework CSS dans le même esprit que TailwindCSS
- [pnpm](https://pnpm.io), gestionnaire de dépendances rapide et efficace
- [TypeScript](https://www.typescriptlang.org), JS mais typé pour assurer la qualité du code
- [MongoDB](https://www.mongodb.com), base de données NoSQL
J'ai décidé de partir sur SolidStart puisque SolidJS est une librairie que j'admire pour réaliser mes interfaces.
C'est pourquoi il me paraît évident de partir sur un framework fullstack qui utilise SolidJS pour le front-end.
Concernant la base de données, j'ai décidé d'aller vers MongoDB pour sa très bonne intégration dans l'écosystème NodeJS (via `mongoose`) et sa facilité d'utilisation.
## Fonctionnalités
- [x] Inscription (+ envoi d'un code OTP par e-mail pour confirmer l'inscription)
- [x] Mot de passe hashé (bcrypt)
- [x] Vérification de la validité de l'adresse e-mail
- [x] Mot de passe >= 8 caractères (bonnes pratiques)
- [x] Connexion
- [x] Suppression de son compte
- [x] Entraine la suppression de toutes les réservations effectuées
- [x] Réservation entre deux dates
- [x] Vérification de la disponibilité
- [x] Liste des réservations effectuées par l'utilisateur
- [x] Annulation d'une réservation
- [x] Recherche de séjours disponibles
- [x] Filtrer par pays
- [x] Filtrer par ville
- [x] Filtrer par continent
- [x] Filtrer par nombre de personnes
- [x] Filtrer par prix
- [x] Filtrer par environnement (campagne, ville, ...)
- [x] Affichage des détails d'un séjour
- [x] Affichage des erreurs (via un toast)
- [x] Personnalisation du nom de l'utilisateur dans le profil
Concernant l'API, il n'y a pas d'OpenAPI disponible, cependant un export [Hoppscotch](https://hoppscotch.io/) est disponible dans le fichier [api.hoppscotch.json](./api.hoppscotch.json). Des identifiants et tokens de démonstration y sont déposés, n'hésitez pas à les changer lors d'une nouvelle authentification.
## Développement
```bash
# On clone le dépôt git
git clone https://github.com/Vexcited/odm-2024
cd odm-2024
# Installation des dépendances
pnpm install
```
Il ne faut pas oublier de créer un fichier `.env` à la racine du projet avec les variables d'environnement contenues dans le fichier `.env.example`.
Vous pouvez démarrer le serveur de développement en utilisant la commande suivante :
```bash
pnpm dev
```
## Production
Nous utilisons le preset `node` par défaut.
```bash
pnpm build
pnpm start
```