diff --git a/README.md b/README.md new file mode 100644 index 0000000..55c2bd1 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# pokerio-server + +[![Build](https://github.com/poker-io/pokerio-server/actions/workflows/main.yml/badge.svg)](https://github.com/poker-io/pokerio-server/blob/main/.github/workflows/main.yml) +[![Lint](https://github.com/poker-io/pokerio-server/actions/workflows/eslint.yml/badge.svg)](https://github.com/poker-io/pokerio-server/blob/main/.github/workflows/eslint.yml) +[![Prettier](https://github.com/poker-io/pokerio-server/actions/workflows/prettier.yml/badge.svg)](https://github.com/poker-io/pokerio-server/blob/main/.github/workflows/prettier.yml) +[![Tests](https://github.com/poker-io/pokerio-server/actions/workflows/test.yml/badge.svg)](https://github.com/poker-io/pokerio-server/blob/main/.github/workflows/test.yml) +[![codecov](https://codecov.io/gh/poker-io/pokerio-server/branch/main/graph/badge.svg?token=4QCZNOWFZJ)](https://codecov.io/gh/poker-io/pokerio-server) + +## Building + +Run `yarn install` + +## Running + +Run `yarn start`. + +## Testing + +We use Jest for testing. To run it, simply type `yarn test`. +Make sure your Node's version is > v18 (`nvm install v18.15.0` to install appropriate version).