Skip to content

Latest commit

 

History

History
320 lines (238 loc) · 7.98 KB

README.md

File metadata and controls

320 lines (238 loc) · 7.98 KB
Raw

GameHub Backlog

Table of Contents

About

GameHub Backlog is a game backlog tracker designed to help you keep track of your ever-growing library of video games. Organize, track, and discover - all in one place!

Features

  • Google Authentication: Securely sign in using your Google account.
  • Comprehensive Game Database: Browse and view details of games worldwide using the IGDB API.
  • Advanced Search and Filtering: Search for games with various filters including Genres, Themes, Platforms, Perspectives, and Game Modes.
  • Game Backlog Management: Track your game progress by adding games to your backlog with status options ('Played', 'Playing', 'Dropped', 'Plan to Play') and progress indicators ('Unfinished', 'Beaten', 'Completed', 'Continuous').
  • Price Comparison: View and compare the prices of Steam games across several trusted stores to find the best deals.
  • User Profiles: Access and manage your profile to view and organize your tracked games. Search for games by name, filter by status and progress, and sort by rating and name. Share your profile with friends and explore other users' profiles to see their game collections.
  • Light and Dark Modes: Switch between light and dark themes for a customizable viewing experience.

Running locally

Clone the project

  git clone https://github.com/goncalojbsousa/gamehub-backlog.git

Enter the project directory

  cd gamehub-backlog

Install dependencies

  npm install

Start the server

  npm run dev

Open http://localhost:3000 with your browser to see the result.

Database

Enter the database directory

  cd database

Run Docker Compose

  docker compose up -d

Edit the .env file in the root directory

  • DATABASE_URL="postgresql://user:password@localhost:5432/auth_db"

Run Prisma migrations

  npx prisma migrate dev

Generate Prisma client

  npx prisma generate

Your database is now ready to use.

Environment Variables

Enter the project directory

  cd gamehub-backlog

Copy .env.example to .env

  cp .env.example .env

Update the .env file with the necessary configuration values.

Contribution

Contributions are welcome and much appreciated! If you want to help improve the GameHub Backlog please read CONTRIBUTING.md

Please follow the code of conduct of this project.

API documentation

Create/update user game status

POST /api/game/updateGameStatus
Parameter Type Description
userId string Mandatory. User identifier (UUID).
gameId number Mandatory. Game identifier (positive number).
status string Mandatory. Game status (maximum 20 characters).
progress string Mandatory. Game progress (maximum 20 characters).

Get user game status

GET /api/game/getGameStatus
Query Parameters:
Parameter Type Description
userId string Mandatory. User identifier (UUID).
gameId string Mandatory. Game identifier (positive number in string format).
Responses:
  • 200 OK: Returns the game status and progress for the specified user and game.
{
    "status": "string", // User's game status
    "progress": "string" // User's game progress
}
  • 400 Bad Request: Returned when userId or gameId are missing or improperly formatted.
{
    "error": "gameId parameter is missing" // Example error message
}
  • 500 Internal Server Error: Returned if there's a server-side issue when fetching the user's game status.
{
    "error": "Internal Server Error"
}

Get user game status by user ID

GET /api/game/getAllGameStatusByUserId
Query Parameters:
Parameter Type Description
userId string Mandatory. User identifier (UUID).
status string Mandatory. Game status (one of: 'Playing', 'Played', 'Dropped', 'Plan to play').
page number Optional. Page number for pagination (defaults to 1).
Responses:
  • 200 OK: Returns the game statuses and progress for the specified user, with pagination.
{
    "data": [
        {
            "gameId": 1942,
            "status": "Played",
            "progress": "Unfinished",
            "gameDetails": {
                "id": 1942,
                "cover": {
                    "id": 89386,
                    "url": "//images.igdb.com/igdb/image/upload/t_thumb/co1wyy.jpg"
                },
                "name": "The Witcher 3: Wild Hunt",
                "rating": 70.56316318546406,
                "slug": "the-witcher-3-wild-hunt"
                "total_rating": 70.56316318546406,
                "websites": [
                    {
                        "id": 185100,
                        "category": 13,
                        "url": "https://store.steampowered.com/app/1623730/Palworld"
                    },
                ],
                "price": "29.99"
            }
        },
    ],
    "totalPages": 2,
    "currentPage": 1
}
  • 400 Bad Request: Returned when userId, status or other parameters are missing or improperly formatted.
{
    "message": "Invalid parameters"
}
  • 403 Forbidden: Returned when the client IP is blocked due to rate limiting.
{
    "message": "Access temporarily blocked. Try again later."
}
  • 429 Too Many Requests: Returned when the rate limit is exceeded.
{
    "message": "Limit rate exceeded. Try again later."
}
  • 500 Internal Server Error: Returned if there's a server-side issue when fetching the user's game statuses or game details.
{
    "message": "Internal server error"
}

Get user data

GET /api/user/getUserData
Query Parameters:
Parameter Type Description
username string Mandatory. Username of the user to fetch.
Responses:
  • 200 OK: Returns the user data for the specified username.
{
  "id": "string", // User's unique identifier (UUID)
  "name": "string", // User's full name
  "image": "string", // URL to the user's profile image
  "createdAt": "string",// Date and time the user was created
  "username": "string" // User's username
}
  • 401 Unauthorized: Returned when the username parameter is missing.
{
  "error": "Username is missing"
}
  • 500 Internal Server Error: Returned if there's a server-side issue when fetching the user's data.
{
  "error": "Internal Server Error"
}

IGDB

All game data is provided by IGDB

Inspirations