Skip to content

Latest commit

 

History

History
119 lines (74 loc) · 3.64 KB

README.md

File metadata and controls

119 lines (74 loc) · 3.64 KB
Raw

Headbands

Video streaming app based on the popular character guessing game

code style: prettier

Headbands is a really popular game you've probably played at work parties. You know where everyone writes a famous name on a sticky note, and puts it on someone else's head? Then they have to ask questions to figure out who they are? Sort of like this (although hopefully your workplace was less offensive.) Unfortunately tons of people are working from home now, so we made this so you can play with eachother online and get some face time that isn't meeting-related.

You can play with up to five players, either playing the guesser one at a time or all at once while taking turns to ask questions. Questions should preferably have yes or no answers but we don't enforce that so you're free to go rogue.

Table of contents

Usage

Navigate to the "How-to-Play" section for instructions.

Demo:

Demo

The above gif demonstrates our basic app flow. For more screenshots and other documentation, navigate to the /docs directory from the root of this repo.

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

If you don't have Nodejs and npm installed, install them from here.

Installing and Running

Clone this repository to your local machine and then create a .env following the .env.example file

Install Dependencies

In the root directory:

npm i

Available Root Commands

Compile and minify for production

npm run build

Start the compiled JS server

npm run start

Start front end dev server

npm run start-react

Built with

  • React - Front-end framework
  • Redux - State management
  • styled-components - Modular, easy-to-navigate styling for React components
  • NodeJS - JS runtime
  • Express - Framework used for API in Node
  • socket.io - JavaScript library for realtime web applications

Contributing

  1. Fork it (https://github.com/jlangy/headbands/fork)
  2. Create your feature branch (git checkout -b feature/fooBar) or issue branch (git checkout -b issue/brokenThing)
  3. Commit your changes (git commit -m 'Add some fooBar')
  4. Push to the branch (git push origin feature/fooBar)
  5. Create a new PR and follow the appropriate template

Meta

Jon Langlois - jlangy - [email protected]

Bryce McMath – bryce-mcmath – [email protected]

Known issues / bugs

  • Bugs? What bugs?

To add an issue, start a new one here.

Feature roadmap

In the works

Planned

If you'd like to add a feature yourself, please see the Contributing guidelines.

Acknowledgements