Skip to content

Repository files navigation

GameWaves

GameWaves is designed to provide users with an easy-to-navigate platform to discover and learn more about the top-rated games of 2023. The website features a user-friendly interface with the following key functionalities:

  • A list of the best-rated games of the year.
  • Detailed information on each game, including screenshots, descriptions, metacritic rating.
  • Extended data about the DLCs for each game.

🎨 Figma Design

For a visual representation of the GameWaves project's design and layout, you can explore our Figma project.

Figma Design

🚀 Deploy

You can access GameWaves by clicking the following button:

VERCEL

🔧 Installation

To run GameWaves locally on your machine, follow these steps:

Prerequisites

  1. Make sure you have Node.js installed on your computer.

Clone the Repository

  1. Open your terminal or command prompt.

  2. Change the current working directory to the location where you want to store the project.

  3. Run the following command to clone the GameWaves repository from GitHub:

    git clone https://github.com/diozenio/games-listing.git

Install Dependencies

  1. Navigate to the project directory using the terminal:

    cd games-listing
  2. Install the project dependencies by running:

    npm install

Setting Up .env.local

To configure your project, you'll need to create a .env.local file. You can use the .env.local.example file as a template. This file contains environment variables required for your application.

Example .env.local

Variable Name Description Example Value
API_URL The URL for the API you're connecting to. https://api.rawg.io/api
API_KEY Your API key to access the API. your_api_key
NEXT_PUBLIC_VERCEL_URL The URL for the Vercel site or for local testing. http://localhost:3000/

Start the Application

  1. After all the dependencies are installed, start the GameWaves application with the following command:

    npm run dev
  2. The application should now be running locally. Open your web browser and visit http://localhost:3000 to access GameWaves.

Run Storybook

  1. To launch Storybook, use the following command in your project directory:

    npm run storybook

💻 Technologies Used

This project utilizes a variety of technologies to provide a powerful and efficient development environment:

React Next.js TypeScript Visual Studio Code Storybook Tailwind CSS Radix UI SCSS

🔖 License

This project is licensed under the MIT License.

About

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages