airboardgame/README.md

31 lines
519 B
Markdown
Raw Normal View History

2020-06-07 20:05:09 +02:00
# Air board game
2020-06-07 20:05:09 +02:00
Play any board game with your friends thanks to this tabletop simulator.
2020-06-15 08:59:21 +02:00
You can try a version [here](https://airboardgame.netlify.app).
2020-06-07 20:05:09 +02:00
## Installation
2020-06-07 20:05:09 +02:00
You need a recent node version. You can use nvm to initialize your environment.
Then, execute
2020-06-07 20:05:09 +02:00
```sh
npm ci # To install dependencies
```
2020-06-27 18:58:12 +02:00
Configure the environement:
Copy the `.env.dist` file without the `.dist` extension and edit it.
Now you can start the server:
2020-06-07 20:05:09 +02:00
```sh
npm run server
```
2020-06-07 20:05:09 +02:00
Then you can run the client:
2020-06-07 20:05:09 +02:00
```sh
npm start
```