Skip to content

Can't decide what to play tonight? Vote to Play! let's you and your friends vote!

License

Notifications You must be signed in to change notification settings

Patchalv/vote-game-app-v6

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Vote to Play!

Can't decide what to play tonight? This app will let you and your friends end that argument by allow you to each vote based on a list of games you input.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Screennshot

One of the things my friends and I like to do on Saturday is crack open a few beers and spend the afternoon playing board games. Pretty much everytime we'll end up asking the question "What game do you want to play?" and spend a load time trying to work out what to play.

So it gave me the idea to come up with this handy little app!

Now all you need to do is pop in the names of 2-5 games you might play, and each person will drag and drop their selection into their personal order of preference.

And then it'll just calculate it for you and give you the list in order of how they were ranked.

Arguments avoided.

Time saved.

Beer drank.

(back to top)

Built With

This following frameworks/libraries were used to bootstrap this project:

React Redux Material-Ui

Notable mentions:

  • dnd kit - Drag and drop toolkit for React.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

  1. Clone the repo
    git clone https://github.com/Patchalv/vote-game-app-v6.git
  2. Install NPM packages
    npm install
  3. Start local development server
    npm run dev
  4. Open browser to http://localhost:3000/

(back to top)

Usage

  1. Players
  • Type the names of the players into the input (2 - 8 players needed).
  • You won't be able to pass on until you insert at least 2 players.
  • You can delete a player by hitting the trash can icon.
  • Click "Add Games >" button when ready.
  1. Games
  • Type the names of the games into the input (3 - 5 games needed).
  • You won't be able to pass on until you insert at least 3 games.
  • You can delete a game by hitting the trash can icon.
  • Click "[Player 1 Name] >" button when ready.
  1. Each person votes
  • The name of the person to vote is at the top of the screen so pass the device to them.
  • The person should drag and drop their selection so that the games are in order of what they most want to play to least (top to bottom).
  • When ready, hit the next player button.
  • You must rearrange the selection before being allowed to move on.
  1. Results
  • After the last person has voted you will be taken to the results page.
  • Click on the "Calculate" button to have the total scores calculated.
  • You will be shown a list of the games in order of how many points they got.

(back to top)

Roadmap

  • Player names instead of player numbers on buttons.
  • Clear state on hitting "Start Again".
  • Total calculated automatically on loading results page, instead of hitting calculate button.
  • Custom url

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

LinkedIn Email Portfolio Github

Whether you want to reach out about this project, collaborating together in the future, or you just want to reach out, please don't hesitiate to get in touch!

(back to top)

Acknowledgments

Some resources that I found helpful and would like to give credit to:

(back to top)

About

Can't decide what to play tonight? Vote to Play! let's you and your friends vote!

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published