Brainrot games

This README was made with AI (i'm too lazy to write it)

This repo will contain a collection of brainrot games. For now, it only contains Word Tuah. A brain rot version of Wordle.

Tech Stack

• React
• TypeScript
• Vite
• Motion for animations

Installation

1. Clone the repository:

git clone https://github.com/The-CodingSloth/brainrot-games.git
cd brainrot-games

2. Install dependencies:

npm install

Running the Game

Development Mode

To run the game in development mode with hot reloading:

npm run dev

This will start the development server at http://localhost:5173 (or another port if 5173 is in use).

Production Build

To create a production build:

npm run build

To preview the production build locally:

npm run preview

Known Issues

The game is still in development and definitely has a lot of bugs.

Contributing

Contributions are welcome! If you'd like to contribute to Word Tuah, please follow these steps:

1. Fork the Repository: Click the "Fork" button at the top right of this repository.

2. Clone Your Fork:

git clone https://github.com/The-CodingSloth/brainrot-games.git
cd brainrot-games

3. Create a Branch: Create a new branch for your feature or bugfix:

git checkout -b feature/your-feature-name

or

git checkout -b fix/your-bugfix-name

4. Make Changes: Implement your changes, following the existing code style.

5. Test Your Changes: Make sure your changes work as expected and don't introduce new bugs (please. I'm too lazy to add tests)

6. Commit Your Changes: Use clear and descriptive commit messages:

git commit -m "Add feature: your feature description"

7. Push to Your Fork:

git push origin feature/your-feature-name

8. Create a Pull Request: Go to the original repository and click "New Pull Request". Select your fork and branch, add a description of your changes, and submit.

Contribution Guidelines

• Follow the existing code style and naming conventions.
• Write clean, readable, and well-documented code.
• Make sure your changes don't break existing functionality.
• Add tests for new features when possible.
• Update documentation as needed.

Development Roadmap

Some ideas for future development:

• I'll think about it...

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Inspiration from the original Wordle game
• Thanks to all contributors and testers

---

Happy coding and game playing! 🎮