✨ Bienvenue sur le projet Apando ✨

📃 Description

Apando est un projet français de création d'une plateforme de communication destiné au domaine de l'enseignement.

Il a pour objectif de fournir un maximum de fonctionnalités au profit des utilisateurs dont un système de chat avec une répartition des différents salons de communications dans des groupes créés par les utilisateurs, une hiérarchie au sein des utilisateurs présents dans un même groupe : Créateur, Administrateur, Délégué, permettant une gestion des utilisateurs dans le même groupe.

Apando utilise la technologie React pour fonctionner ainsi que de nombreux autres packages tels que material-ui, firebase, react-markdown, react-express... dans le but d'offrir la meilleure expérience possible à l'utilisateur.

🎀 Pourquoi utiliser Apando ?

De nombreux services de chat existent de nos jours, alors pourquoi Apando ?

Apando est un service de chat qui se vise conforme à la RGPD et qui cherche à offrir les meilleurs outils aux enseignants, groupes d'élèves et autres tiers dont de futurs intégrations comme une API Ecole Directe, Google Agenda ou des filtres personnalisables de mots...

Il est orienté pour une mise en place rapide de groupes avec des mots de passe personalisables pour y accéder ainsi que d'un système de rôle afin de surveiller le contenu et le réglementer, ainsi que de modifier ce groupe.

Vous devriez aller y jeter un coup d'œil !

🤝 Contribuer

Nous sommes toujours ouverts à des contributeurs de tous niveaux ! Si vous essayez de vous frailler un chemin dans ce projet, essayez de commencer par ouvrir une première Issue.

Si vous êtes intéressé pour nous aider au développement du site Apando par la contribution, n'hésitez pas à venir dans notre serveur Discord.

🚀 Installation

Pour ceux qui sont motivés pour améliorer le code du site, sinon rendez-vous sur le site web !

NB : Vous devez disposer de la clé d'API pour pouvoir faire tourner le site à 100 %. Seuls les contributeurs vérfiés sont autorisés à la posséder. Si vous voulez faire des tests liés à cela malgré tout, créez votre propre projet Firebase ou venez gentillement demander !

Prérequis

NodeJS installé
Yarn installé

Étape 1. Installer Apando

Télécharger le code source depuis GitHub via son .zip ou par git clone

$ git clone https://github.com/Taliayaya/Project-Plateforme.git

Étape 2. Installer les dépendances

Depuis le répertoire du projet,

$ yarn install

$ npm install

Par défaut, Yarn est préféré

Étape 3. Lancer en localhost