https://github.com/lestoni/rochambeau
https://github.com/lestoni/rochambeau
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/lestoni/rochambeau
- Owner: lestoni
- Created: 2022-02-11T15:53:01.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-12T00:28:17.000Z (over 3 years ago)
- Last Synced: 2023-08-05T05:03:41.230Z (almost 3 years ago)
- Language: TypeScript
- Size: 1.21 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ROCHAMBEAU
[ROCHAMBEAU](https://bit.ly/3rvU71t)
## Architecture and Design
Game API is built with expressJS in a simplified layout microservice repo structure.
## How to run
Dockerized application is using latest node slim.
Build and Run it with from repo root
```
$ ./tools/build-docker.sh
```
You can use a client like postman to test out the REST API.
For the cli app, please make sure to generate an access token by logging in via the api.
Export it to the your environment as such `export ROCHAMBEAU_ACCESS_TOKEN=xxxxxxxxxx`. Build the project to use the dist version of the app by running `$ npm run build`
1. Run it from the repo via `$ npm run cli` or
2. Run `$ npm link` to have access to it via cli then run it as `$ rochambeau`
## Architecture and Design
### API
RESTFul API is accessible via `/v1`.
### Swagger Docs
API Documentation is available in `http://localhost:8000/docs`.
### CLI App
## Improvements
- Use streaming to play in realtime
- data validation(Schemas)
- ...