Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

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!