diff --git a/README.md b/README.md index 15fc347..d9a6ba1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,63 @@ -# SAE_2A_Anglais + +# SAE 2A Anglais + +This project aims to facilitate the learning of English in the context of higher studies thanks to a website and a mobile application. +## Run Locally + +Clone the project + +```bash + git clone https://codefirst.iut.uca.fr/git/antoine.jourdain/SAE_2A_Anglais.git +``` + +Go to the project directory + +```bash + cd SAE_2A_Anglais +``` + +Follow the following instructions according to your need. + +### PHP + +Switch branch + +```bash + git switch php +``` + +Go to the php directory + +```bash + cd Project/php +``` + +Create composer files + +```bash + php composer.phar install + php composer.phar dump-autoload +``` + +Launch your apache server and don't forget to execute ```createdb.sql``` and ```defaultinsert.sql``` on your Local SQL Server before using the site. + +### Blazor + +Switch branch + +```bash + git switch blazor +``` + +Choose Project/adminBlazor.sln in Visual Studio.\ +Launch and enjoy the admin app. + + + +## Authors + +- [@anthony.richard](https://codefirst.iut.uca.fr/git/anthony.richard) +- [@patrick.brugiere](https://codefirst.iut.uca.fr/git/patrick.brugiere) +- [@lucie.goigoux](https://codefirst.iut.uca.fr/git/lucie.goigoux2) +- [@antoine.jourdain](https://codefirst.iut.uca.fr/git/antoine.jourdain)