StudyStorm est la meilleure plateforme d'apprentissage en ligne pour les étudiants.

StudyStorm est un projet de groupe, open source, réalisé dans le cadre du cours PDG du semestre d'été de la HEIG-VD.

• Alen Bijelic
• Nicolas Crausaz
• Jonathan Friedli
• Lazar Pavicevic
• Maxime Scharwath

Cliquez-ici pour voir le trailer !

L’application StudyStorm permet aux utilisateurs de créer des collections de cartes de révision et de les partager avec d’autres utilisateurs de la plateforme.

Vous souhaitez contribuer au savoir commun ? Créez une salle de classe ! Le créateur d’une salle de classe peut partager ses collections à tout le monde ou rendre la salle de classe privée, en invitant uniquement les utilisateurs qu’il souhaite, à rejoindre la salle de classe. Organisez votre salle de classe d’une manière semblable à un système de dossier afin de regrouper les cartes par sujet, chapitre, unité de cours, etc…

La communauté peut évaluer le contenu qu’elle a apprécié ou pas. Les collections avec le plus de votes positifs sont mises en avant sur la page d’accueil. Les cartes étant réalisées par des personnes, il est possible qu’il y ait des erreurs dans la réponse d’une carte, ou qu’il y ait une réponse plus pertinente. Les utilisateurs ont la possibilité de signaler une carte en proposant une meilleure réponse. C’est ensuite de la responsabilité du créateur de la carte d’appliquer le changement.

Pour lancer la base de donnée vous aurez uniquement besoin de Docker.
Une fois docker installé, vous pouvez lancer la base de donnée en exécutant la commande suivante:

docker run --name sql-studystorm -p 5432:5432 -e POSTGRES_USER=user -e POSTGRES_PASSWORD=password123 -e POSTGRES_MULTIPLE_DATABASES=studystorm,studystorm_test gradescope/postgresql-multiple-databases:14.4

Warning
Si vous avez déjà une base de donnée en local sur le port 5432, vous devrez changer le port (celui à droite des " : " ) dans la commande ci-dessus.

Cela aura pour effet de créer un container avec une PostgresSQL 14.4, avec deux bases de données: studystorm et studystorm_test. Nous pourrons ensuite communiquer avec elles via le port 5432.

Les préréquis et instructions pour lancer la partie frontend du projet sont dans la doc du repository, disponible ici.

Les préréquis et instructions pour lancer la partie backend du projet sont dans la doc du repository, disponible ici.

Afin de contribuer à ce projet, il vous suffit de clone le repository et de créer une nouvelle branche. Dès votre premier commit, il faut créer une Pull Request en mode "Draft". Ensuite, à chaque nouveau commit, une action github va s'occuper de lancer les tests unitaires et de vérifier que le code est bien formaté.

Chaque commit aura la forme suivante : Un préfixe, puis : et enfin un message rédigé en anglais.
Les préfixes sont les suivants :

• feat: pour une nouvelle fonctionnalité
• fix: pour une correction de bug
• docs: pour une modification de la documentation
• refactor: pour une modification de code qui n'ajoute pas de fonctionnalité ni de bug
• chore: pour une modification de configuration.

Exemple de commit : feat: add register page for new users

Une fois la PR prête à être mergée, vous pouvez la mettre en mode "Ready for review" et un autre membres de l'équipe va s'occuper de la review. Si tout est bon, la PR sera mergée dans la branche dev et votre contribution sera ajoutée au projet. Vous pourrez ensuite supprimer votre branche.

Afin de déployer une fonctionnalité en production, il suffit de merge la branche dev (après s'être assuré qu'elle ne contient plus aucun bug et passe tous les tests) dans la branche main. DigitalOcean, qui watch notre branche main, va alors se charger de déployer la nouvelle version de l'application. Cela peut prendre entre 5 et 10 minutes.
Vous pourrez ensuite voir vos nouvelles fonctionnalité directement sur le site https://studystorm.net/.