Welcome to Hookie! This is a fascinating twist on Scrabble Hooks with a touch of reverse charm. This project leverages the robust boardgame.io framework with the power of React, Redux, and WebSockets to create an engaging and strategic gameplay. ππ»π
Imagine a game of Scrabble where you peel off layers of words rather than constructing them. This is Hookie! The game begins with a word sprouting from the center star. As players, you carefully deconstruct words, unraveling them until you're left with a core. Once there are no subwords left to discover, it's time to place a new word. This cycle repeats until you've exhausted all the letters in the Scrabble bag. πβππ
To get started with development, you'll need to set up your local environment. Please ensure you have Node.js and npm installed before proceeding.
-
Clone the Repository: Use
git clone
to get a copy of the repository on your local machine. -
Install Dependencies: Navigate to the project directory and run
npm install
to install all necessary dependencies. -
Start the Development Server: Run
npm start
to start the local development server. -
Testing: Ensure all new additions are covered with tests. Run
npm test
to execute the test suite.
Feel free to explore the codebase and experiment with features or improvements!
Hookie blends modern web technologies to create a compelling gaming experience:
- boardgame.io: A game development framework perfect for building turn-based games.
- React: A JavaScript library for crafting interactive UIs.
- Redux: A reliable state container for JavaScript applications.
- WebSockets: Allowing real-time, bidirectional communication between the game server and clients.
- Heroku: A platform-as-a-service (PaaS) used to deploy, run, and manage the application.
Hookie is hosted on Heroku, which offers a robust, scalable cloud platform that easily accommodates our game's growth.
Contributions of all forms are welcome - from bug fixes to documentation improvements and new features. To contribute:
- Fork the Repository: Create a copy of the Hookie repository on your GitHub account.
- Clone the Forked Repository: Get a local copy of the fork on your machine.
- Create a New Branch: Make your changes in this branch.
- Implement Changes: Implement your bug fixes, enhancements, or new features.
- Commit and Push Changes: Ensure your commit messages are clear and meaningful.
- Create a Pull Request: We'll review your contributions and possibly merge them into the main codebase.
Hookie thrives on its community and represents more than just a game. It's a dynamic, evolving project with an array of opportunities to learn, contribute, and have fun. So prepare your strategic mind, and let's dive into the exciting world of unraveling words! πππ
Ready to get hooked on Hookie? ππ²π€