Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 2.29 KB

README.md

File metadata and controls

97 lines (66 loc) · 2.29 KB
Raw

🎮 GamerShelf

Description |  Deploy |  Tech Stack |  Environment Variables |  Install & Scripts |  Contribution |  License


GamerShelf Thumbnail

📙 Description

GamerShelf is a web application that allows gamers to keep track of their game collection in one convenient place. Upon visiting the website, users can add games to their virtual shelves. The app also allows users to filter games and add them to their collection with ease.

Each game in the collection has its own page with information such as the title, release date, platform, genre, and a description.

This web app utilizes the free-to-play API.

💻 Deploy

⚙️ Functionality

  • View a specific game details
  • Add and remove games from library
  • Filter games based on a set of chosen of parameters

🛠 Tech Stack

  • Vite
    • React
      • Redux & Redux Toolkit
      • React Router
      • React Icons
      • React Toastify
    • TypeScript
  • Tailwind
    • Classnames
  • ESLint + Prettier
    • Airbnb JavaScript Style Guidelines

🔢 Environment Variables

This web app needs three Environment Variables:

    VITE_RAPID_API_KEY
    VITE_RAPID_API_HOST
    VITE_GAMES_API_BASE_URL

All three variables are type string and provided by Rapid API

👨‍💻 Install and Scripts

Download and setup the environment variables in a .env file in your root folder

Install dependecies on NPM:

  npm install

Run local server:

  npm run dev

Format files with Airbnb JavaScript Style Guidelines:

  npm run format

Create build for deploying:

  npm run build

👥 Contribution

If you'd like to contribute with to project, simply open up a Pull Request.

🔑 License

MIT