https://github.com/joanbr4/api-class-dice-game
https://github.com/joanbr4/api-class-dice-game
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/joanbr4/api-class-dice-game
- Owner: joanbr4
- Created: 2024-03-04T12:44:26.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-28T11:49:44.000Z (about 1 year ago)
- Last Synced: 2025-02-07T09:20:20.639Z (3 months ago)
- Language: TypeScript
- Size: 7.41 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project of Dice Game Table
A funny table game with 2 dice, where 2 players takes turns throwing both dice. the first player to roll a total of 7 wins!
## What features can we expect?
- Class Code
- Validation Routes with JWT
- Unit Test with Jest
- Hexagonal Architecture
- Prisma ORM
## How to setup?
For a better experience, this project was made with docker features, you can install it here.
After that, we need to create a connection and synchronize it with our Prisma ORM. Just copy the following command into your terminal.
```sh
npm i
npm run docker
npm run generate
```
Now just lets check it out with some virtual Client like POSTMAN, INSOMNIA or our best extension ThunderCLient VSC, but before run our server.
```sh
npm run build
```
## Testing?
To prevent any issue and ensure that all functions works as expected, we need to test every function or route. You can choose to run all or a subset of the tests, whichever you prefer.
```sh
npm run test
```
```sh
npm run test:players
```
```sh
npm run test:games
```
## API Documentation??
We'll use ThunderClient or a free-alternative-to-share Rest Client extension of VSC
For Rest Client :
- In `api.http` will have all queries and its properties
- Data `setting.json` must be in general setting file of VSC
- To get value of {{ value }}, press Ctr + shitf + P => Rest Client: Switch Environment => local