Coloc+ 🏡

🎯 À propos

Coloc+ est une application facilitant la gestion des tâches et des dépenses au sein d'une colocation, permettant aux colocataires de rester organisés et de partager équitablement les responsabilités.

• Gestion des tâches
• Gestion des dépenses communes
• Calendrier partagé pour suivre tâches et dépenses
• Messagerie pour donner des infos à vos colocataires

🚀 Stack

Front-end :

• JavaScript — Langage Frontend
• NPM — Gestionnaire de paquets
• Webpack — Bundler
• Eslint — Linter
• Axios — Requêtes HTTP
• Full Calendar — Calendrier
• Vanilla Calendar — Input des dates
• Slim Select — Multi-select personnalisé
• Bulma CSS — Framework CSS
• Font Awesome — Icônes

Back-end :

• Nginx — Serveur web
• PHP — Langage backend
• Composer — Gestionnaire de dépendances PHP
• MySQL — Base de données

✅ Prérequis

Avant de commencer 🏁, vous devez avoir Git et NPM installé.

🏁 Lancer le projet

Récupérer le projet

# Clone this project
$ git clone https://gitlab.com/BenoitPrmt/app-colo

# Access
$ cd app-colo

Front-end

# Accéder au frontend
$ cd frontend

# Installer les dépendances
$ npm install

# Lancer le projet
$ npm run start

# Le site va démarrer sur <http://127.0.0.1:9090>

Back-end

# Accéder au backend
$ cd backend

# Installer les dépendances
$ composer install
$ composer dump-autoload

# Lancer le serveur PHP (MacOS avec brew)
$ brew services start php
$ brew services start nginx

Lancez nginx en prenant le soin d'utiliser la configuration nginx.conf présente la racine du projet. Démarrez MAMP ou XAMP sur le port 8888. Dans PhpMyAdmin, créez une base de données nommée app-colo et importez le fichier app-colo.sql présent dans le dossier backend/database.

Si vos identifiants mySQL ne sont pas root (pour l'identifiant) et root (pour le mot de passe), vous pouvez les modifier dans le fichier backend/src/models/SqlConnect.php.

Le serveur PHP (API) devrait se lancer sur le port 8080.

🪄 Tester

Pour tester l'application, vous pouvez utiliser les comptes suivants :

• Compte avec colocation, des tâches et des dépenses

  • Email : obiwan@kenobi.com
  • Mot de passe : Password1?

• Compte sans colocation

  • Email : han@solo.com
  • Mot de passe : Password1?

Ou alors vous pouvez créer un compte et naviguer dans l'application pour tester les fonctionnalités.

Made with ❤️ by Benoît