-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5d467cb
commit 45d2dc3
Showing
1 changed file
with
80 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# GameHub | ||
|
||
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: | ||
|
||
```bash | ||
git clone https://github.com/HoussamMrabet/game-hub.git | ||
``` | ||
|
||
2. Navigate to the project directory: | ||
|
||
```bash | ||
cd game-hub | ||
``` | ||
|
||
3. Install the dependencies: | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
4. 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](https://rawg.io/apidocs). | ||
|
||
``` | ||
REACT_APP_RAWG_API_KEY=your-api-key | ||
``` | ||
|
||
## Usage | ||
|
||
Once you have installed the dependencies and provided the API key, you can start the development server: | ||
|
||
```bash | ||
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](LICENSE). | ||
|
||
## Acknowledgements | ||
|
||
- [RAWG.io](https://rawg.io/) for providing the game data API. | ||
- [Vite](https://vitejs.dev/) for the efficient build tooling. | ||
- [Chakra UI](https://chakra-ui.com/) for the sleek and accessible component library. | ||
- [Axios](https://axios-http.com/) for simplified HTTP requests. | ||
|
||
## Contact | ||
|
||
For any inquiries or feedback, please contact [houssammrabet5@gmail.com](mailto:houssammrabet5@gmail.com). |