Github/uno-online
1
0
Fork 1
mirror of https://github.com/mizanxali/uno-online synced 2024-12-23 17:47:43 +00:00
Code Issues Projects Releases Wiki Activity
Two player online game of UNO. Made using React and Socket.IO uno-online-multiplayer.herokuapp.com/
44 Commits 1 Branch 0 Tags 12 MiB
JavaScript 89.8%
CSS 8.3%
HTML 1.9%
ffd734cde4
Go to file
Mizanali Panjwani ffd734cde4 Updated README
2021-03-05 05:27:50 +05:30
client UI improvement 2021-03-03 15:11:18 +05:30
screenshots Updated README 2021-03-05 05:27:50 +05:30
.gitignore Changed folder structure 2021-02-22 05:02:50 +05:30
package-lock.json Set up socketio server-client connection 2021-02-22 05:29:23 +05:30
package.json Deployment setup 2021-03-02 15:07:36 +05:30
README.md Updated README 2021-03-05 05:27:50 +05:30
server.js Added text chat functionality 2021-03-03 03:59:42 +05:30
users.js Working two-player game ready! 2021-02-22 21:04:17 +05:30

README.md

UNO ONLINE

Two player online game of UNO.

🤔 What is UNO?

UNO is the classic and beloved card game that’s easy to pick up and impossible to put down! Players take turns matching a card in their hand with the current card shown on top of the deck either by color or number. Special action cards deliver game-changing moments as they each perform a function to help you defeat your opponents. These include Skips, reverses, draw twos, color-changing wild and draw four wild cards.

⚠️ Game Rules

Read the complete rules of UNO here.

❓ About the game

This two-player online version of the game was built with React, Socket.IO, Express and Node.js.

🧐 How to play?

  1. Once you're on the homepage of the game, you can either host a new game or join a friend's game.
  2. To host a new game, click on CREATE GAME. A game code will be generated which you can share with your friend.
  3. To join a friend's game, enter the game code given by them, and click on JOIN GAME.
  4. That's it! Enjoy the game and do not get toxic! 😄

🎮 Screenshots

Screenshot 1 Screenshot 2

🏁 Getting Started (to run game locally)

Follow the steps below, after cloning the repository:

🖐 Requirements

For Installing:

  • Node

⏳ Installation

  • (At the root of the project directory, use npm to install the server-side dependencies)
npm install

This command installs all the server-side dependencies needed for the game to run locally.

  • (Use npm to run server)
npm start

This command gets the server running on localhost port 5000.

  • (In a separate terminal, navigate into the client folder and use npm to install the client-side dependencies)
cd client
npm install

This command installs all the client-side dependencies needed for the game to run locally.

  • (Finally, use npm to run client)
npm start

This command gets the client running on localhost port 3000.

Head over to http://localhost:3000/ and enjoy the game! 🎉

🤝 Contributing

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

  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

❤️ Acknowledgements

  • AlexDer for the UNO cards assets!