Game Deck

Your Next Gaming Adventure

       

 See it in Action  »

Introduction · Features · Tech Stack · Development Setup · Contributing

❄️ Introduction

GameDeck is a vibrant platform that lets gamers discover, explore, and play a curated collection of games, all powered by React. Delve into the codebase to explore more.

🔋  Features

• Organized File and Folder Structure

• Fully Responsive Design

• Well-organized & intuitive UI

• Server Side State Management & Caching using Tanstack Query.

• Client Side States Management with Zustand

• Custom Hooks for separation of concerns

• Security Measures like proxy-server with rate limiting.

• Documentation with local development setup guide.

• Dark and Light Mode

⚙️  Tech Stack

• React – frontend

• Chakra UI – Component library

• Tanstack Query – Asynchronous State Management

• Zustand – State Management

• Node.js – JavaScript runtime

• Express – Framework

• Git – Versioning

• Vite – Building

• Vercel – Deployments

🖥️   Local Development

0. Prerequisites
   Make sure you have the following installed on your machine:

   • Git
   • Node.js
   • pnpm (Package Manager)

1. Clone the repository:

   git clone https://github.com/yntpdotme/game-deck.git

2. Navigate to the project directory:

   cd game-deck

3. Setup Proxy-Server:

   • Navigate to the Proxy-Server Codebase:

     cd proxy-server/

   • Install dependencies:

     pnpm install

   • Add Environment Variables:

     Create .env file in the root folder and copy paste the content of .env.sample

     cp .env.sample .env

     Update credentials in .env with your credentials.

   • Start the Server:

     pnpm dev

   • Explore the API:

     Access the project APIs at the specified endpoints using API Docs.

4. Setup Frontend:

   • Navigate to the Frontend Codebase:

     cd client/

   • Install dependencies:

     pnpm install

   • Add Environment Variables:

     Create .env file in the root folder and copy paste the content of .env.sample

     cp .env.sample .env

     If required, update necessary credentials.

   • Start the frontend app:

     pnpm dev

   • Open app in browser:

     Visit https://localhost:5173 to access frontend.

🤝  Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

🪪   License

GameDeck is open-source under the MIT License. Feel free to learn, add upon, and share!