diff --git a/README.md b/README.md index cf53ba1..f85bbf6 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,86 @@ -# Projet Web +

Projet Web - M1 ISA 💻

+

+ Technologies - Lancer le projet - Auteurs +

-Au début: -```sh -pnpm i -# or -npm i -```` +

Projet réalisé dans le cadre du cours de Web languages for data storage and management.

-et après +

💻 Technologies

-```sh -pnpm dev --open -# or -npm run dev -``` \ No newline at end of file +- SvelteKit +- MongoDB +- Redis +- Docker + +

🚀 Lancer le projet

+ +Afin de lancer le projet en local, vous aurez besoin de suivre les instructions suivantes + +

Clonez le dépôt

+Commencez par cloner le dépôt Git sur votre machine + +```bash +git clone https://github.com/NabilOuldHamou/M1_ProjetWeb +``` + +

Production

+Installez **Docker** sur votre machine puis utilisez la commande suivante pour lancer le projet + +```bash +docker compose up +``` + +Ensuite, modifiez les données suivantes dans le fichier `.env` + +```yaml +JWT_SECRET="..." +MONGO_ROOT_USERNAME="..." +MONGO_ROOT_PASSWORD="..." +MONGO_DEFAULT_DB="..." +``` + +

Développement

+TODO + +

🤝 Auteurs

+ + + + + + + + + + + +
+ +Nabil Profile Picture
+ +Nabil Ould Hamou + +
+
+ +Bilal Profile Picture
+ +Bilal Dieumegard + +
+
+ +Yacine Profile Picture
+ +Yacine Hbada + +
+
+ +Yanis Profile Picture
+ +Yanis Bouarfa + +
+