Twitch/Chatman
0
0
Fork 0
Code Issues Activity
An API that allows Twitch to play Hangman in chat.
20 commits 2 branches 0 tags 125 KiB
Find a file
Oliver-Akins dddb1068be Integrate socket io into the server
2023-02-19 20:45:12 -07:00
src Integrate socket io into the server 2023-02-19 20:45:12 -07:00
.gitignore Add the words directory to the gitignore 2023-01-07 18:05:17 -06:00
config.template.toml Update default config file 2023-01-20 00:01:33 -06:00
generateInterfaces.ts Initial commit 2022-12-23 15:19:37 -06:00
makefile Remove interface prereq 2023-01-07 17:01:32 -06:00
package.json Add socket.io as a dependency 2023-02-19 12:10:53 -07:00
pnpm-lock.yaml Add socket.io as a dependency 2023-02-19 12:10:53 -07:00
README.md Make the README relevant to the project 2023-01-20 00:07:03 -06:00
tsconfig.json Initial commit 2022-12-23 15:19:37 -06:00

README.md

Chatman

A REST API that can be used to play Hangman with predefined words.

Originally developed to play Hangman in CzechGamesEdition's Twitch Channel 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.