Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guilhermebkel/uno-game
:flower_playing_cards: An UNO Game made in Javascript
https://github.com/guilhermebkel/uno-game
eslint express game games git-commit-message-linter husky javascript jsgames lerna lint-staged material-ui react-dnd reactjs socketio typescript uno uno-game
Last synced: about 1 month ago
JSON representation
:flower_playing_cards: An UNO Game made in Javascript
- Host: GitHub
- URL: https://github.com/guilhermebkel/uno-game
- Owner: guilhermebkel
- License: mit
- Created: 2020-06-27T15:26:33.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T16:29:11.000Z (2 months ago)
- Last Synced: 2024-04-16T18:29:54.327Z (2 months ago)
- Topics: eslint, express, game, games, git-commit-message-linter, husky, javascript, jsgames, lerna, lint-staged, material-ui, react-dnd, reactjs, socketio, typescript, uno, uno-game
- Language: TypeScript
- Homepage: https://uno.guilherr.me
- Size: 15.8 MB
- Stars: 188
- Watchers: 5
- Forks: 54
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-jsgames - UNO - The famous UNO card game with online multiplayer support! (Uncategorized / Uncategorized)
README
An UNO Game made in Javascript 🎴
## 📌 Overview
A simple UNO Game made in Javascript, supposed to be blazing easier and faster than Gartic to start playing.
## 🔧 Technologies
- Typescript
- React.js
- Socket.io
- Lerna
- Express
- Material UI
- Husky
- Lint Staged
- Git Commit Message Linter
- ESLint
- React DnD
- MsgPackParser
## 🚀 Getting started
1. Clone this repository
2. Run the following command
```sh
# Install all shared dependencies
# Install dependencies for api
# Install dependencies for client
# Link all packages dependencies together
# Add env file for api
# Add env file for client
npm run setup
```
3. Run the command below inside the root folder to startup all the needed resources (such as Redis).
```sh
npm run dev:resources
```
3. Run the command bellow inside **packages/unoenty** and **packages/unapy** to start api and client.
```sh
npm run dev
```
Right here everything should be working fine. So, **api** will be available at **http://localhost:5000** and **client** will be available at **http://localhost:4000**.
## 👏 Contributing
1. Clone this repository to your machine.
2. Create a new branch locally following the **Git Karma** pattern. Ex: feat/my-awesome-feature.
3. Then, after coding your contribution, make a merge request for your branch.
## 🗺️ Roadmap
Since we want to keep improving this game, you are able to see what we plan to do next on our [**Roadmap**](https://github.com/guilhermebkel/uno-game/projects/1). Any idea or suggestion of improvement and bug solving is welcome!
## 💫 Contributors
Thanks to all the people who contributed on this project!
