diff --git a/README.md b/README.md index f0b0874..c707c96 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,45 @@ -# CRI +# C.R.I (Centre de Resistance à L'Incompetence) -Centre de Resistance a l'incompetence +Le but est de créé un application mobile (Android/iOS) qui permet de regrouper et d'automatiser une majorité des services d'epita (epita.it + epilife sous stéroides) -Si vous voulez aider: [Thread discord](https://discord.com/channels/1024607619345825832/1361382929376346122) +## Objectifs +les objectifs principaux sont les suivants: + - envoie d'une notification dès que Fatou rajoute une absences + - envoie d'une notifcation dès que Fatou change Zeus + +objectifs secondaires: + - permettre de justifier les absence directement depuis l'appli + - integration avec discord (un peu redondant mais why not) + - better pegasus (pareil notif et un meilleur frontend) + - un better cri (maybe) + +## Stack +- Flutter (avec Dart ou Kotlin, j'ai pas encore décidé) +- NixPkgs (moi j'aime bien quand les truc marche donc on utilise nix) +- Pour la DB ca m'etonnerait qu'on en ait besoin mais redis (ou equivalent) + +### Flutter +Flutter permet de créé des appli qui tournent nativement sur tout les OS (même le web), ca appartient a Google donc ca manque pas de docu et c'est une des solutions principal dans le monde de l'entreprise, suivi de React native mais qui a toujour des problèmes de perf + +### Redis +super bonne base de donné simple a utiliser + moderne + +### NixPkgs +pas besoin d'installer NixOs juste le package manager si vous êtes sur Linux c'est ez si vous êtes sur windows manger mon paf + +## Timing +les objectifs principaux pour la rentré en septembre, le reste osef, et on verra plus en detail en fonction de comment on avance + +## Coding Style +- moi j'aime bien bander quand je vois du code donc yaura un coding style a respecter (je l'ai pas encore ecrit mais il arrive). +- Faite un commit par petit truc (c'est mieux 50 commits que un gros commit avec plein de truc) +- pour les branches `prenom/feature` + +## La Docu +tout doit être documenté pour que ca soit plus lisible + +## L'equipe +je prend tout ceux qui sont motiver d'apprendre peut importe le niveau, je garde quand même un veto. + + +si vous avez des question hesitez pas 👀