ChatBux est une application basique de messagerie en temps réel. La partie frontend est écrite en React (Initialisée avec Vite). Le partie backend utilise le framework ExpressJS comme serveur.
Dés qu'un utilisateur est incrit, il peut recevoir et envoyer à tous les autres utilisateurs inscrits sur le site. Vous n'avez pas besoin d'envoyer une invitation pour discuter avec un autre utilisateur.
L'application est écrite en JavaScript, elle sera executée dans un environement Node. Il est impératif d'avoir Node et NPM d'installer.
- Créer un dossier du projet
mkdir chatbux
cd chatbux
- Cloner les repositories (backend et frontend) avec la ligne de commande
git clone https://github.com/lexnotor/chatbux-back.git backend
git clone https://github.com/lexnotor/chatbux-front.git frontend
- Installer les modules necessaires. Entrer dans les deux sous dossiers (frontend et backend) et executer la commande
cd backend
npm install
cd ../frontend
npm install
- Ajouter les fichiers .env dans les deux sous dossiers
chatbux/backend/.env
MONGODB_URI="MONDODB_DATABASE_CONNEXION_STRING"
FRONTEND_URI="URL_FROM_WHICH_THE_BACKEND_WILL_ACCEPT_REQUEST"
CLOUD_NAME="CLOUDINAY_API_CLOUD_AME"
API_KEY="CLOUDINAY_API_API_KEY"
API_SECRET="CLOUDINAY_API_API_SECRET"
chatbux/frontend/.env
VITE_BACKEND_URL='URL_LOCATE_THE_BACKEND'
S'assurer que l'utilisateur Mongodb utiliser a le droit de lire et ecrire dans la base de données selectionnée. Cette base de données doit contenir deux collections (users et chats).
S'assurer d'avoir un compte sur cloudinary, ceci permettra de rendre les images persistantes
L'execution du projet se passe en 2 étapes; la première est de lancer l'application backend, et la seconde est de lancer l'application frontend. Assurer vous que les ports 3500 et 5173 ne sont pas utilisés.
- Démarrer l'application backend
cd backend
npm start
- Démarrer l'application frontend
cd frontend
npm start
- Enfin, Ouvrir le lien de l'application dans un navigateur.