Commit 7ef7f94c authored by Zohten's avatar Zohten

updated doc

parent f670ca08
# projet-cdaw # Projet de mahjong
## Auteurs
- VREL Quentin (FISE 2021)
- ARNAULT Augustin (FISE 2021)
Les 2 auteurs ont contribués à parts égales.
Quentin s'est majoritairement concentré sur la partie Frontend (visuel + logique front) et Augustin sur la partie Backend (logique front et back). Nous précisons que les 2 auteurs ont touché aux 2 aspects (front et back) ce qui est vérifiable dans les commits.
## Arborescence du projet
```ascii
.
├ README.md # Vous êtes ici
├ AGL # Contient ce qui est relatif à la construction de BDD
| ├ BD # Les instruction SQL pour générer la BDD avec des examples
| └ Conception # Des fichiers de PowerDesign
├ Backend # Contient ce qui est relatif au backend
| ├ src # Code de l'API REST de notre backend
| └ TPs # Archives de TP backend
├ doc # Contient la documentation
├ frontend # Contient le frontend
├ Laravel # TP Laravel
└ UX # Contient ce qui est relatif au maquettage du frontend
├ figma # Figma file
└ Maquette_mahjong.pdf # Ce à quoi devait ressembler le site
```
## Installation
C.f la documentation [Installation](doc/Installation.md).
## Fonctionnalitées
# Installation
## Cloner le repo
'''bash
git clone http://gvipers.imt-lille-douai.fr/QVrel/projet-cdaw.git
cd projet-cdaw
git submodule init
git submodule update
'''
## MySQL
Il faut d'abord fournir les éléments pour se connecter à MySQL, pour cela aller dans le fichier `BackEnd/src/config/config.php`.
```PHP
define('DB_HOST', '127.0.0.1'); // Mettre l'IP du serveur MySQL
define('DB_PORT', 3306); // Mettre le port du serveur MySQL
define('DB_DATABASE', 'dbtest'); // Mettre le nom de la BDD MySQL
define('DB_USERNAME', 'root'); // Mettre le username de connexion
define('DB_PASSWORD', 'root'); // Mettre le mot de passe associé au user
```
Pour info, version MySQL de notre serveur : 5.7.30
## PHP
Rien de spécial mais pour info, version de notre PHP : 7.4.9
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment