https://github.com/matt-d-webb/chess-player-api
https://github.com/matt-d-webb/chess-player-api
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/matt-d-webb/chess-player-api
- Owner: matt-d-webb
- License: mit
- Created: 2020-03-24T14:02:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-28T02:05:53.000Z (over 1 year ago)
- Last Synced: 2024-05-28T22:39:26.839Z (about 1 year ago)
- Language: JavaScript
- Size: 448 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Chess Player - RESTful API
[](https://travis-ci.org/matt-d-webb/chess-player-api)
[](https://coveralls.io/github/matt-d-webb/chess-player-api?branch=master)
A boilerplate/starter project for quickly building production-ready RESTful APIs using Node.js, Express, and Mongoose.
It comes with many built-in features, such as authentication using JWT, request validation, unit and integration tests, continuous integration, docker support, etc. For more details about the features, check the list below.
## Getting Started
### Installation
Install dependencies:
```bash
yarn install
```
Environment varibales:
```bash
cp .env.example .env
# open .env and modify the environment variables (if needed)
```
### Commands
Running locally:
```bash
yarn dev
```
Running in production:
```bash
yarn start
```
Testing:
```bash
# run all tests
yarn test
# run all tests in watch mode
yarn test:watch
# run test coverage
yarn coverage
```
Docker:
```bash
# run docker container in development mode
yarn docker:dev
# run docker container in production mode
yarn docker:prod
# run all tests in a docker container
yarn docker:test
```
Linting:
```bash
# run ESLint
yarn lint
# fix ESLint errors
yarn lint:fix
# run prettier
yarn prettier
# fix prettier errors
yarn prettier:fix
```