shakhbozbekusmonov/game-hub

This is React TypeScript Game hub discovery web application.

Game Hub Discovery Web Application

Welcome to the Game Hub Discovery web application! This application leverages the RAWG API to provide a platform for discovering and exploring video games. Whether you're a gamer looking for new titles or a developer interested in using this API, this documentation will guide you through the setup and usage.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Configuration
• Usage
  • Endpoints
• Contributing
• License

Getting Started

DEMO Game-Hub.

Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js installed on your machine.
• An API key from RAWG API, which is required for accessing their data.

Installation

1. Clone this repository to your local machine:

git clone https://github.com/shakhbozbekusmonov/game-hub.git

2. Navigate to the project directory:

cd game-hub

3. Install the project dependencies:

npm install

Configuration

Create a .env file in the root directory of your project to store your RAWG API key:

VITE_REACT_APP_API_KEY=your_api_key_here
VITE_REACT_APP_API_PATH=your_api_path_here

Usage

Endpoints

The application provides the following endpoints:

• /games: Retrieve a list of games.
• /games/:id: Get details about a specific game.
• /search/:query: Search for games based on a query.
• /genres: Retrive a list of genres.

For detailed information on how to use these endpoints, refer to the RAWG API documentation.

Contributing

We welcome contributions from the community. If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Create a pull request to the main repository.

License

This project is licensed under the MIT License.