diff --git a/README.md b/README.md index 4abe9bf..fdd0a30 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,39 @@ -# ![Chromacase](./assets/graphical/title.png) +# ![Chromacase](./assets/graphical/banner.png) La principale raison pour laquelle on arrête de jouer d'un instrument est la perte de motivation. C'est un apprentissage long et vraiment demandant. ChromaCase propose d'accompagner les joueurs de piano grâce à une application mobile avec une expérience personnalisée. Celle-ci, générée par une IA, cible les goûts et identifie les difficultés du joueur. -Ça vous interesse? Rendez-vous sur notre [site](https://chromacase.studio/) pour prendre contact +Ça vous interesse? Rendez-vous sur notre [site](http://eip.epitech.eu/2024/chromacase) pour prendre contact -## Structure du Projet +## Comment lancer le projet -![Schéma Fonctionnel](./assets/docs/structure.png) +Pensez à remplir un `.env` (à la racine du projet), en se basant sur le `.env.example`. + +### Development + +```bash +docker-compose -f docker-compose.dev.yml up --build +``` + +### Production + +```bash +docker-compose up --build +``` + +## Liens Utiles + +- Site de Production: [Lien](http://chroma.octohub.app/) +- Site du Nightly: [Lien](http://nightly.chroma.octohub.app/) +- Site vitrine: [Lien](http://eip.epitech.eu/2024/chromacase) +- Documentation: [Github](https://github.com/Chroma-Case/DAteX) + +## Membres du Projet + +| Nom | Role | Contact | +|--------------------------|--------------------------------------|----------------------------------------------------| +| Zoé Roux | CEO, Responsable Back-end | [GitHub](https://github.com/zoriya) | +| Clément Le-Bihan | CTO, Responsable Front-end | [GitHub](https://github.com/Octopus773) | +| Arthur Jamet | Manager, Développeur Front-end | [GitHub](https://github.com/Arthi-chaud) | +| Louis Auzuret | Développeur Back-end, Responsable CI | [Github](https://github.com/GitBluub) | +| Aumaury Danis-Cousandier | Développeur Front-end | [Github](https://github.com/AmauryDanisCousandier) | +| Mathys Paul | Développeur Front-end, Designer | [GitHub](https://github.com/mathysPaul) | diff --git a/assets/graphical/banner.png b/assets/graphical/banner.png new file mode 100644 index 0000000..06dbc3d Binary files /dev/null and b/assets/graphical/banner.png differ