https://github.com/akpetitrust/whot
A game of Naija Whot built with ReactJS
https://github.com/akpetitrust/whot
react redux socket-io whot
Last synced: 6 months ago
JSON representation
A game of Naija Whot built with ReactJS
- Host: GitHub
- URL: https://github.com/akpetitrust/whot
- Owner: AkpetiTrust
- Created: 2022-04-23T16:16:36.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-12T15:53:54.000Z (about 2 years ago)
- Last Synced: 2025-04-09T22:44:21.109Z (10 months ago)
- Topics: react, redux, socket-io, whot
- Language: JavaScript
- Homepage: https://whot.trust-akpeti.com
- Size: 7.59 MB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Naija Whot (Open Source)
This is a game of Naija Whot built for the web. It has both single and multiplayer features. You can check it out [live here](https://whot.trust-akpeti.com).
## Technologies ⚙
Front end:
- React
- Redux
- [React-flip-toolkit (for animations)](https://github.com/aholachek/react-flip-toolkit)
- SCSS
Back end
- socket.io (Running on Node)
## Running project 🚀
The repo has three branches:
- main: This holds the front end React code.
- server: This holds the socket server code.
- gh-pages: For Github Pages hosting.
To run the project locally:
1. Clone the main branch
```
git clone https://github.com/AkpetiTrust/whot.git
```
2. Run the front end using npm
```
npm install && npm start
```
3. Clone the server branch
```
git clone -b server https://github.com/AkpetiTrust/whot.git
```
4. Run the server using node
```
node index.js
```
## Contributing 💻
Contributions are surely welcome! You can check out the [public roadmap](https://github.com/AkpetiTrust/whot/wiki/Public-Roadmap) to see the feature ideas in store for the game, then [create a new issue](https://github.com/AkpetiTrust/whot/issues/new/choose) if you're interested in contributing to any. If the idea you have isn't in the roadmap, still feel free to create a new issue to talk about the idea.