Welcome to YourGamingLibrary, a platform where you can explore information about various video games. This documentation provides detailed instructions on how you can clone the repository to your local machine and set up the project for development.
YourGamingLibrary is a web application built with modern web technologies, including React, Vite, Express, and various UI libraries such as Chakra UI, Material-UI, and more. The platform aims to provide users with comprehensive information about video games, including popular games, release dates, ratings, storylines, summaries, developer companies, genres, platforms, and in-game screenshots.
To get started with YourGamingLibrary on your local machine, follow the steps below:
Before you begin, ensure that you have the following installed on your machine:
Open your terminal and run the following command to clone the repository:
git clone https://github.com/yourusername/yourgaminglibrary.git
Replace yourusername with your GitHub username.
Navigate to the project directory:
cd yourgaminglibrary
Install project dependencies using npm:
npm install
Create a .env file in the root of the project and configure the necessary environment variables. You can use the provided .env.example file as a reference.
Start the development server with the following command:
npm run dev
Visit http:https://localhost:3000 in your browser to view YourGamingLibrary.
YourGamingLibrary follows a modular project structure. Here are some key directories:
- client/src: Contains the source code for the frontend application.
- client/assets: Screenshots and logos.
- server: Contains the Express server code.
YourGamingLibrary offers the following features:
- Landing Page: Displays popular games.
- Detailed Game: Information: Access information about each game, including name, release date, score, storyline, summary, developer companies, genres, platforms, and screenshots.
The project uses various development tools, including Vite for bundling, ESLint for linting, Prettier for code formatting, and more. Refer to the package.json file for a complete list of dependencies and scripts.
I do not plan to accept contributions at the moment, but you can point out the features you see missing in the "Issues" section.