Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 2.33 KB

README.md

File metadata and controls

80 lines (50 loc) · 2.33 KB
Raw

Game Hub

GameHub is a React web application built with Vite and TypeScript. It provides a platform for discovering and exploring games across various platforms. The application utilizes Chakra UI for design, Axios for API requests, and relies on the RAWG.io API for game data.

Features

  • Browse games across different genres and platforms.
  • View detailed descriptions and information about individual games.
  • Search for specific games.

Installation

To get started with GameHub, follow these steps:

  1. Clone the repository:
git clone https://github.com/HoussamMrabet/game-hub.git
  1. Navigate to the project directory:
cd game-hub
  1. Install the dependencies:
npm install
  1. Create a .env file in the root directory and provide your RAWG.io API key. You can obtain an API key by signing up at RAWG.io.
VITE_REACT_API_KEY=your-api-key

Usage

Once you have installed the dependencies and provided the API key, you can start the development server:

npm run dev

This command will launch the application in development mode, and the server will be accessible at your localhost.

Dependencies

GameHub utilizes the following major dependencies:

  • React: JavaScript library for building user interfaces.
  • Vite: Next-generation frontend build tooling.
  • TypeScript: Typed superset of JavaScript.
  • Chakra UI: Modular component library for React.
  • Axios: Promise-based HTTP client for making API requests.

For the complete list of dependencies, please refer to the package.json file.

Contributing

Contributions to GameHub are welcome! If you find any bugs, issues, or have suggestions for improvements, please open an issue or submit a pull request.

When contributing, please adhere to the existing code style and follow the established patterns and conventions.

License

GameHub is open source and distributed under the MIT License.

Acknowledgements

  • RAWG.io for providing the game data API.
  • Vite for the efficient build tooling.
  • Chakra UI for the sleek and accessible component library.
  • Axios for simplified HTTP requests.

Contact

For any inquiries or feedback, please contact houssammrabet5@gmail.com.