Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clarkio/chakeyra
A live streaming game where the streamer and viewers in chat compete to typing challenges
https://github.com/clarkio/chakeyra
hacktoberfest javascript twitch
Last synced: 17 days ago
JSON representation
A live streaming game where the streamer and viewers in chat compete to typing challenges
- Host: GitHub
- URL: https://github.com/clarkio/chakeyra
- Owner: clarkio
- License: mit
- Created: 2020-10-30T18:56:09.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T05:51:48.000Z (28 days ago)
- Last Synced: 2024-10-17T21:23:06.589Z (26 days ago)
- Topics: hacktoberfest, javascript, twitch
- Language: JavaScript
- Homepage:
- Size: 356 KB
- Stars: 8
- Watchers: 4
- Forks: 2
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# chakeyra[![Known Vulnerabilities](https://snyk.io/test/github/clarkio/chakeyra/badge.svg)](https://snyk.io/test/github/clarkio/chakeyra)
![GitHub](https://img.shields.io/github/license/clarkio/chakeyra)
[![Discord](https://img.shields.io/discord/421902136457035777)](https://discord.gg/xB95beJ)
[![Twitch Status](https://img.shields.io/twitch/status/clarkio)](https://twitch.tv/clarkio)
[![Twitter Follow](https://img.shields.io/twitter/follow/_clarkio?style=social)](https://twitter.com/intent/follow?screen_name=_clarkio)A live streaming game where the streamer and viewers in chat compete in a typing speed challenge
Thanks to @timothee for the name of this game ππ
## Clarkio
This game was built with π live on stream with the programming community. Come and hang out with us over on Twitch!> https://twitch.tv/clarkio
[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg)](#contributors-)
### Prerequisites
- Node.js: [nvm](https://github.com/nvm-sh/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows)
### Update/create your .env file
In the root of the repo, you'll see an example [.env.example](.env.example) file, copy this, and create a `.env` file
Fill in the following fields in your new `.env` file:
- TWITCH_CLIENT_ID
- TWITCH_CLIENT_SECRET
- TWITCH_CHANNEL_ID### Getting Started (traditional)
1. Open your terminal/command line tool
1. Run `npm install`
1. Run `npm start`
1. Open your browser to [http://localhost:3000/](http://localhost:3000/)### Getting Started (Docker)
1. Open your terminal/command line tool
1. Run `docker-compose up`
1. Open your browser to [http://localhost:3000/](http://localhost:3000/)### Playing the Game
1. Click "Start"
1. You (the streamer) will receive a set of words and can begin typing them out character by character
1. Your chat will receive a smaller set of words and once they send single character messages to your chat room it will validate them again their separate words
1. The first to complete every character wins## Contributors β¨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Chris Jones
π» π€
RadosΕaw Miluk
π€
Daggersoath
π€
ssobus
π€
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!