From 53928254825a878546155c2120552d480788b239 Mon Sep 17 00:00:00 2001 From: Raphael <16480203+sundowndev@users.noreply.github.com> Date: Mon, 28 Oct 2019 16:10:36 +0100 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ef8ee06..80e4176 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,42 @@ -# Eemiens vs Héticiens +# HÉTIC vs EEMI Plus Eemien ou Héticien ? Le jeu qui ne fait pas rire les élèves. ## Project setup -Launch REST API: +Clone repository + +``` +git clone https://github.com/sundowndev/HETICvsEEMI +``` + +Install core dependencies ``` -cd server npm install -npm start +npm run bootstrap ``` -Start client: +Launch REST API ``` -cd client -npm install +node server +``` + +Start client + +``` +cd client/ npm run serve ``` Then you can browse the client at `http://localhost:8080/` and the API at `http://localhost:3000/`. +### API routes + +- **/questions** returns an array of questions +- **/schools** returns an array of schools + ### Client development #### Compiles and hot-reloads for development @@ -52,4 +67,4 @@ npm run test:e2e #### Run your unit tests ``` npm run test:unit -``` \ No newline at end of file +```