Update README.md
parent
1c77a75b72
commit
5392825482
31
README.md
31
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
|
||||
```
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue