README ta3 les fous
This commit is contained in:
parent
a52023e84f
commit
61ae5e5965
1 changed files with 82 additions and 13 deletions
95
README.md
95
README.md
|
@ -1,17 +1,86 @@
|
||||||
# Projet Web
|
<h1 align="center" style="font-weight: bold;">Projet Web - M1 ISA 💻</h1>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="#tech">Technologies</a> - <a href="#started">Lancer le projet</a> - <a href="#auth">Auteurs</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
Au début:
|
<p align="center">Projet réalisé dans le cadre du cours de <strong>Web languages for data storage and management</strong>.</p>
|
||||||
```sh
|
|
||||||
pnpm i
|
|
||||||
# or
|
|
||||||
npm i
|
|
||||||
````
|
|
||||||
|
|
||||||
et après
|
<h2 id="technologies">💻 Technologies</h2>
|
||||||
|
|
||||||
```sh
|
- SvelteKit
|
||||||
pnpm dev --open
|
- MongoDB
|
||||||
# or
|
- Redis
|
||||||
npm run dev
|
- Docker
|
||||||
```
|
|
||||||
|
<h2 id="started">🚀 Lancer le projet</h2>
|
||||||
|
|
||||||
|
Afin de lancer le projet en local, vous aurez besoin de suivre les instructions suivantes
|
||||||
|
|
||||||
|
<h3>Clonez le dépôt</h3>
|
||||||
|
Commencez par cloner le dépôt Git sur votre machine
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/NabilOuldHamou/M1_ProjetWeb
|
||||||
|
```
|
||||||
|
|
||||||
|
<h3>Production</h3>
|
||||||
|
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="..."
|
||||||
|
```
|
||||||
|
|
||||||
|
<h3>Développement</h3>
|
||||||
|
TODO
|
||||||
|
|
||||||
|
<h2 id="auth">🤝 Auteurs</h2>
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<td align="center">
|
||||||
|
<a href="https://github.com/NabilOuldHamou">
|
||||||
|
<img src="https://github.com/NabilOuldHamou.png" width="100px;" alt="Nabil Profile Picture"/><br>
|
||||||
|
<sub>
|
||||||
|
<b>Nabil Ould Hamou</b>
|
||||||
|
</sub>
|
||||||
|
</a>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td align="center">
|
||||||
|
<a href="https://github.com/Luxray555">
|
||||||
|
<img src="https://github.com/Luxray555.png" width="100px;" alt="Bilal Profile Picture"/><br>
|
||||||
|
<sub>
|
||||||
|
<b>Bilal Dieumegard</b>
|
||||||
|
</sub>
|
||||||
|
</a>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td align="center">
|
||||||
|
<a href="https://github.com/YacineHB">
|
||||||
|
<img src="https://github.com/YacineHB.png" width="100px;" alt="Yacine Profile Picture"/><br>
|
||||||
|
<sub>
|
||||||
|
<b>Yacine Hbada</b>
|
||||||
|
</sub>
|
||||||
|
</a>
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td align="center">
|
||||||
|
<a href="https://github.com/Yanax373">
|
||||||
|
<img src="https://github.com/Yanax373.png" width="100px;" alt="Yanis Profile Picture"/><br>
|
||||||
|
<sub>
|
||||||
|
<b>Yanis Bouarfa</b>
|
||||||
|
</sub>
|
||||||
|
</a>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
Loading…
Add table
Reference in a new issue