/howler

Primary LanguageTypeScript

Matching Game Project README

Introduction

Welcome to the Matching Game Project! This project is a React.js application developed with TypeScript, aimed at providing an engaging and challenging matching game experience. Players will test their memory and skills by matching items within a specified number of tries. Upon successful matches, players will collect bananas, prominently displayed on the final screen as a testament to their success.

Features

  • Engaging Matching Game: Players can enjoy a fun and interactive matching game experience.
  • Memory Testing: Test your memory and skills by matching items within a defined number of tries.
  • Dynamic Data Integration: Data for the game can be dynamically sourced from either a JSON file or a database, providing flexibility and scalability.
  • TypeScript Integration: Utilizes TypeScript to define data structures, ensuring type safety and proper integration of key fields.

Installation

  1. Clone the repository from [https://github.com/zenrsr/howler.git].
  2. Navigate to the project directory.
  3. Run npm install to install dependencies.
  4. Run npm start to start the development server.
  5. Open the application in your browser at http://localhost:3000.

How to Play

  1. Upon launching the game, players will be presented with a grid of cards, each containing hidden items.
  2. Players can flip two cards at a time to reveal the hidden items.
  3. The objective is to match pairs of identical items within the specified number of tries.
  4. Upon successful matches, players will collect bananas, displayed prominently on the final screen.
  5. The game ends when all items have been successfully matched or when the maximum number of tries is reached.

Technologies Used

  • React.js: JavaScript library for building user interfaces.
  • TypeScript: Typed superset of JavaScript that compiles to plain JavaScript.
  • Figma: Design tool used for creating the design layout of the game.
  • JSON: Data interchange format used for dynamically sourcing game data.

Credits

  • Developed by Raga Sandeep Reddy
  • Design provided by brightCHAMPS

License

This project is licensed under the MIT License

Feedback

We welcome any feedback or suggestions for improvement. Please feel free to contact us with your thoughts.

Thank you for playing the Matching Game! We hope you enjoy it!