Twitch/Chatman
0
0
Fork 0
Code Issues Activity

Make the README relevant to the project

Browse source
This commit is contained in:
Oliver-Akins 2023-01-20 00:07:03 -06:00
parent e94e64ddbc
commit 6261f19229
1 changed files with 16 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,2 +1,16 @@
# Hapi-API-Template
An API template based on Hapi.
# Chatman
A REST API that can be used to play Hangman with predefined words.
Originally developed to play Hangman in [CzechGamesEdition's Twitch Channel](https://twitch.tv/CzechGamesEdition)
using the custom Codenames deck created by chat submissions.
# Setup
## Development
1. `pnpm install` (install pnpm if it isn't installed already)
2. `cp config.template.toml config.toml`
3. `make interfaces` (re-run whenever you change a schema in `src/schemas/*`)
4. `make dev` (compiles and runs the code in dev mode) or `make rund` (skips the compile step, runs it in dev mode)
## Production
1. Same steps as Development, but use `make run` to run the API in production mode. You may need to change the `NODE` argument in the makefile to make it run correctly.