GG Requestz

https://github.com/xtreemmak/ggrequestz
Admin
GG Requestz is a modern game discovery and request management platform with IGDB integration, game...
Tokens:58,689
Snippets:685
Trust Score:7.2
License:GPL-3.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Run from Source Development

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/QUICKSTART.md

Install dependencies, configure the environment, and start the development server.

```bash
npm install
cp .env.example .env
npm run dev
```

--------------------------------

### Start Database Services for Development

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/QUICKSTART.md

Start the required database services and run migrations when developing from source.

```bash
docker compose up -d postgres redis
npm run db:migrate
```

--------------------------------

### Start development server

Source: https://github.com/xtreemmak/ggrequestz/blob/main/CONTRIBUTING.md

Launch the local development server.

```bash
npm run dev
```

--------------------------------

### Start and Monitor Application

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/QUICKSTART.md

Commands to start the Docker services and monitor their status and logs.

```bash
# Start all services
docker compose up -d

# Check status
docker compose ps

# View logs
docker compose logs -f ggrequestz
```

--------------------------------

### Start ggrequestz with Docker

Source: https://github.com/xtreemmak/ggrequestz/blob/main/README.md

Commands to clone the repository, prepare the environment file, and start the services using Docker Compose.

```bash
# Clone repository
git clone https://github.com/XTREEMMAK/ggrequestz.git
cd ggrequestz

# Configure environment
cp .env.example .env
nano .env  # Add your IGDB credentials and settings

# Start with Docker Compose
docker compose up -d

# Visit http://localhost:3000
```

--------------------------------

### SQL Migration Example

Source: https://github.com/xtreemmak/ggrequestz/blob/main/CONTRIBUTING.md

Example of a migration script for adding a user preferences table, following the project's requirement for descriptive naming and schema management.

```sql
// migrations/007_add_user_preferences.sql
-- Add user preferences table
CREATE TABLE ggr_user_preferences (
  id SERIAL PRIMARY KEY,
  user_id VARCHAR(255) NOT NULL REFERENCES ggr_users(id),
  preference_key VARCHAR(100) NOT NULL,
  preference_value TEXT,
  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  UNIQUE(user_id, preference_key)
);

-- Add indexes for performance
CREATE INDEX idx_user_preferences_user_id ON ggr_user_preferences(user_id);
CREATE INDEX idx_user_preferences_key ON ggr_user_preferences(preference_key);
```

--------------------------------

### POST /api/setup/check

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Check service connectivity during setup.

```json
{
  "service": "igdb_api"
}
```

```json
{
  "success": true,
  "service": "igdb_api",
  "status": "connected",
  "details": "IGDB API accessible"
}
```

--------------------------------

### Pull and start pre-built images

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/QUICKSTART.md

Use these commands to pull the pre-built image from the GitHub Container Registry and start the services in detached mode.

```bash
docker compose pull
docker compose up -d
```

--------------------------------

### Install dependencies

Source: https://github.com/xtreemmak/ggrequestz/blob/main/CONTRIBUTING.md

Install required project dependencies using npm.

```bash
npm install
```

--------------------------------

### Configure environment variables

Source: https://github.com/xtreemmak/ggrequestz/blob/main/CONTRIBUTING.md

Create the .env file from the example template.

```bash
cp .env.example .env
# Edit .env with your configuration
```

--------------------------------

### Start Authentik test environment

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/TESTING.md

Command to bring up the Authentik test profile.

```bash
docker compose -f docker-compose.test.yml --profile authentik up -d
```

--------------------------------

### Execute database/setup-postgres.js

Source: https://github.com/xtreemmak/ggrequestz/blob/main/scripts/README.md

Command to run the direct PostgreSQL setup script for environments with direct database access.

```bash
node scripts/database/setup-postgres.js setup
```

--------------------------------

### Conventional Commits format examples

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/dev-notes/ENGINEERING_RULES.md

Examples of commit messages following the Conventional Commits specification.

```text
feat: add OIDC discovery document support
fix: add timeout to ROMM authentication request
docs: rewrite OIDC setup guide for generic providers
refactor: consolidate duplicate ROMM fetch implementations
```

--------------------------------

### Initialize database from source

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/DATABASE_SETUP.md

Start the PostgreSQL service and manually trigger the database migration process when running the application from source.

```bash
docker compose up -d postgres    # or point .env at your own server
npm run db:migrate
```

--------------------------------

### Build images locally

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/QUICKSTART.md

Use these commands to build the images from source locally before starting the services.

```bash
docker compose build
docker compose up -d
```

--------------------------------

### Enable Debug Environment Variables

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/CONFIGURATION.md

Examples of how to run the development server with specific debug flags enabled for troubleshooting.

```bash
# Enable all debug logging
DEBUG_AGE_RATINGS=true DEBUG_IGDB_QUERIES=true DEBUG_USER_AUTH=true VITE_DEBUG_VIEWPORT_CACHING=true npm run dev

# Enable only viewport caching debug (useful for mobile optimization)
VITE_DEBUG_VIEWPORT_CACHING=true npm run dev

# Enable only authentication debug
DEBUG_USER_AUTH=true npm run dev
```

--------------------------------

### Monitor migration logs

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/TESTING.md

Example output from the application logs showing the migration sequence and skipped migrations.

```text
⏭️  Skipping 001_initial_schema.sql (already executed)
⏭️  Skipping 002_complete_schema_updates.sql (already executed)
🔄 Running migration: 008_add_animated_background_preference.sql
```

--------------------------------

### cURL API Integration with API Key

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Command line examples for interacting with the API using an Authorization header.

```bash
# Store your API key
export GGR_API_KEY="ggr_your_api_key_here"

# Get game details
curl -H "Authorization: Bearer $GGR_API_KEY" \
     "https://your-domain.com/api/games/72129"

# Search for games
curl -H "Authorization: Bearer $GGR_API_KEY" \
     "https://your-domain.com/api/search?q=zelda"

# Add to watchlist
curl -X POST \
     -H "Authorization: Bearer $GGR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"igdb_id":"72129"}' \
     "https://your-domain.com/api/watchlist/add"

# Get popular games with filtering
curl -H "Authorization: Bearer $GGR_API_KEY" \
     "https://your-domain.com/api/games/popular?page=1&limit=20"
```

--------------------------------

### Define a new migration file

Source: https://github.com/xtreemmak/ggrequestz/blob/main/migrations/README.md

Example of a migration file structure using defensive SQL practices.

```sql
-- Migration: 009_add_widget_preference
-- Description: Per-user widget layout preference

ALTER TABLE ggr_users
  ADD COLUMN IF NOT EXISTS widget_layout JSONB DEFAULT '[]'::jsonb;
```

--------------------------------

### GET /api/version

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Returns application version, environment details, and feature availability.

```APIDOC
## GET /api/version

### Description
Returns application version and feature information.

### Method
GET

### Endpoint
/api/version

### Response
#### Success Response (200)
- **version** (string) - Application version
- **name** (string) - Application name
- **environment** (string) - Deployment environment
- **buildTime** (string) - Build timestamp
- **features** (object) - Enabled features
- **api** (object) - API version and endpoint list
```

--------------------------------

### GET /api/version

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Returns the application version, environment details, build time, enabled features, and available API endpoints.

```json
{
  "version": "1.5.0",
  "name": "gg-requestz",
  "environment": "production",
  "buildTime": "2026-07-26T12:00:00Z",
  "features": {
    "oidc": true,
    "basicAuth": true,
    "redis": true,
    "romm": true,
    "typesense": false
  },
  "api": {
    "version": "v1",
    "endpoints": [
      "/api/games",
      "/api/auth",
      "/api/requests",
      "/api/watchlist",
      "/api/admin"
    ]
  }
}
```

--------------------------------

### Write integration tests with mocked fetch

Source: https://github.com/xtreemmak/ggrequestz/blob/main/CONTRIBUTING.md

Example of an integration test in tests/integration/ that mocks the global fetch function.

```javascript
// tests/integration/romm-token-lifecycle.test.js
global.fetch = vi.fn().mockResolvedValue(response(500));

const { isRommAvailable } = await freshRomm();
await expect(isRommAvailable()).resolves.toBe(false);
```

--------------------------------

### GET /api/cache/stats

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Get cache statistics.

```APIDOC
## GET /api/cache/stats

### Description
Get cache statistics.

### Method
GET

### Endpoint
/api/cache/stats

### Response
#### Success Response (200)
- **success** (boolean) - Status of the request
- **stats** (object) - Cache statistics for redis and memory

#### Response Example
{
  "success": true,
  "stats": {
    "redis": {
      "connected": true,
      "keyCount": 1250,
      "memoryUsed": "15.2MB"
    },
    "memory": {
      "keyCount": 500,
      "estimatedSize": "5.1MB"
    }
  }
}
```

--------------------------------

### Set up database

Source: https://github.com/xtreemmak/ggrequestz/blob/main/CONTRIBUTING.md

Initialize the database using either Docker or a local PostgreSQL instance.

```bash
# Option 1: Use Docker
docker compose up -d postgres redis
npm run db:migrate

# Option 2: Local PostgreSQL
createdb ggrequestz
npm run db:init
```

--------------------------------

### GET /api/romm/recent - Get recent ROMs

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Retrieve a list of recently added ROMs from the ROMM library.

```json
{
  "success": true,
  "roms": [
    {
      "id": "123",
      "name": "Super Mario Bros.",
      "platform": "NES",
      "added_at": "2025-09-29T12:00:00Z"
    }
  ],
  "hasMore": true
}
```

--------------------------------

### GET /api/user/preferences - Retrieve user preferences

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Get the user's current content filtering preferences.

```json
{
  "success": true,
  "preferences": {
    "content_filter_level": "mild",
    "hide_mature_content": true,
    "hide_nsfw_content": true,
    "max_esrb_rating": "T",
    "custom_content_blocks": ["violence", "gambling"],
    "preferred_genres": ["Adventure", "RPG"],
    "excluded_genres": ["Horror", "Sports"],
    "apply_to_homepage": true,
    "apply_to_popular": true,
    "apply_to_recent": false,
    "apply_to_search": true
  }
}
```

--------------------------------

### Database Setup and Migration Commands

Source: https://github.com/xtreemmak/ggrequestz/blob/main/scripts/README.md

Commands to initialize the database, run pending migrations, check status, and warm up the cache using the db-manager.js script.

```bash
# Initialize database
node scripts/database/db-manager.js init

# Run all pending migrations
node scripts/database/db-manager.js migrate

# Check migration status
node scripts/database/db-manager.js status

# Warm up cache
node scripts/database/db-manager.js warm
```

--------------------------------

### Example of anti-pattern commit history

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/dev-notes/ENGINEERING_RULES.md

This shows an example of poor commit history where multiple unrelated changes are bundled into single commits, violating the one logical change per commit rule.

```text
687aef7 Release v1.2.5: Global content filtering and critical bug fixes
bf494c2 Release v1.2.3: Critical security fixes and granular permissions
b6b29a7 Complete UI improvements from previous session
```

--------------------------------

### Clone the repository

Source: https://github.com/xtreemmak/ggrequestz/blob/main/CONTRIBUTING.md

Initial steps to download the project source code.

```bash
git clone https://github.com/XTREEMMAK/ggrequestz.git
cd ggrequestz
```

--------------------------------

### GET /api/images/proxy

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Proxy and cache external images.

```APIDOC
## GET /api/images/proxy

### Description
Proxy and cache external images.

### Method
GET

### Endpoint
/api/images/proxy

### Parameters
#### Query Parameters
- **url** (string) - Required - Image URL to proxy

### Response
#### Success Response (200)
- **binary** (blob) - Image binary data with appropriate headers.
```

--------------------------------

### GET /api/games/recent

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Retrieves a list of recently released games.

```APIDOC
## GET /api/games/recent

### Description
Get recently released games.

### Method
GET

### Endpoint
/api/games/recent

### Parameters
#### Query Parameters
- **page** (number) - Optional - Page number (default: 1)
- **limit** (number) - Optional - Results per page (default: 16)
- **user_id** (string) - Optional - User ID for content filtering
```

--------------------------------

### Start stack with external access

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/TESTING.md

Configures the application to accept connections from a different host by setting the bind address and origin host.

```bash
GGR_TEST_HOST=0.0.0.0 GGR_TEST_ORIGIN_HOST=<lan-ip> \
  docker compose -f docker-compose.test.yml up -d app
```

--------------------------------

### GET /api/search

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Search for games using query parameters.

```APIDOC
## GET /api/search

### Description
Search games with IGDB integration.

### Method
GET

### Endpoint
/api/search

### Parameters
#### Query Parameters
- **q** (string) - Required - Search query
- **page** (number) - Optional - Page number
- **per_page** (number) - Optional - Results per page
- **autocomplete** (boolean) - Optional - Return autocomplete suggestions

### Response
#### Success Response (200)
- **success** (boolean) - Search status
- **hits** (array) - Search results
- **found** (number) - Total results found
- **page** (number) - Current page
```

--------------------------------

### GET /admin/api/navigation

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Retrieve all navigation items. Requires navigation.manage permission.

```APIDOC
## GET /admin/api/navigation

### Description
Get all navigation items. Requires `navigation.manage` permission.

### Method
GET

### Endpoint
/admin/api/navigation
```

--------------------------------

### Clone and Configure Repository

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/QUICKSTART.md

Commands to clone the repository and prepare the environment configuration file.

```bash
# Clone the repository
git clone https://github.com/XTREEMMAK/ggrequestz.git
cd ggrequestz

# Copy environment template
cp .env.example .env

# Edit .env with your settings
nano .env
```

--------------------------------

### GET /api/romm/recent

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Retrieve recently added ROMs from the ROMM library.

```APIDOC
## GET /api/romm/recent

### Description
Get recently added ROMs from the ROMM library.

### Method
GET

### Endpoint
/api/romm/recent

### Parameters
#### Query Parameters
- **page** (number) - Optional - Page number
- **limit** (number) - Optional - Results per page

### Response
#### Success Response (200)
- **success** (boolean) - Status
- **roms** (array) - List of ROMs
- **hasMore** (boolean) - Pagination indicator
```

--------------------------------

### GET /api/igdb

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Proxy for IGDB API to retrieve game data.

```APIDOC
## GET /api/igdb

### Description
Direct IGDB API proxy for game data retrieval.

### Method
GET

### Endpoint
/api/igdb

### Parameters
#### Query Parameters
- **action** (string) - Required - IGDB action (search, details, etc.)
- **query** (string) - Optional - Search query
- **limit** (number) - Optional - Result limit
```

--------------------------------

### Development Commands

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/QUICKSTART.md

List of available npm scripts for development, building, testing, and linting.

```bash
npm run dev         # Dev server on :5174
npm run build       # Production build
npm run preview     # Preview the production build
npm run check       # svelte-check
npm run lint        # prettier --check (this is what CI gates on)
npm run format      # prettier --write
npm run test:unit   # vitest
npm run test:e2e    # playwright
```

--------------------------------

### GET /api/user/preferences

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Retrieve the user's content filtering preferences.

```APIDOC
## GET /api/user/preferences

### Description
Get the current user's content filtering preferences.

### Method
GET

### Endpoint
/api/user/preferences

### Response
#### Success Response (200)
- **success** (boolean) - Status of the operation
- **preferences** (object) - User preference settings
```

--------------------------------

### Monitor database initialization and migration logs

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/DATABASE_SETUP.md

Use this command to watch the logs for schema initialization and migration progress during the Docker container startup.

```bash
docker compose logs -f ggrequestz | grep -iE "schema|migration"
```

--------------------------------

### GET /api/games/recent Response

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Returns a list of recently released games.

```json
{
  "success": true,
  "games": [...],
  "hasMore": true,
  "total": 500
}
```

--------------------------------

### GET /api/health

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Health check endpoint for monitoring system status.

```APIDOC
## GET /api/health

### Description
Health check endpoint for monitoring.

### Method
GET

### Endpoint
/api/health

### Response
#### Success Response (200)
- **status** (string) - System status
- **timestamp** (string) - Current timestamp
- **uptime** (number) - System uptime in seconds
- **version** (string) - Application version
```

--------------------------------

### Run database/db-manager.js Commands

Source: https://github.com/xtreemmak/ggrequestz/blob/main/scripts/README.md

Usage instructions for the unified database manager script, which handles initialization, migrations, and cache operations.

```bash
node scripts/database/db-manager.js <command>

Commands:
  init     - Initialize database with core tables
  migrate  - Run pending database migrations
  status   - Show migration status and pending migrations
  warm     - Warm up the games cache
  stats    - Show cache statistics
  fix      - Fix migration table issues
```

--------------------------------

### GET /api/games/{id}

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Retrieve detailed information for a specific game by its ID.

```APIDOC
## GET /api/games/{id}

### Description
Retrieves detailed information for a specific game.

### Method
GET

### Endpoint
/api/games/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the game
```

--------------------------------

### POST /admin/api/keys/create

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Create a new API key. Requires apikey.create permission.

```APIDOC
## POST /admin/api/keys/create

### Description
Create a new API key. Requires apikey.create permission.

### Method
POST

### Endpoint
/admin/api/keys/create

### Request Body
- **name** (string) - Required - Name for the API key
- **scopes** (array) - Required - List of scopes
- **expires_at** (string) - Optional - Expiration timestamp

### Response
#### Success Response (200)
- **success** (boolean) - Status of the request
- **key** (string) - The generated API key
- **id** (integer) - Key ID
```

--------------------------------

### GET /api/cache/stats

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Retrieves current cache statistics for Redis and memory storage.

```json
{
  "success": true,
  "stats": {
    "redis": {
      "connected": true,
      "keyCount": 1250,
      "memoryUsed": "15.2MB"
    },
    "memory": {
      "keyCount": 500,
      "estimatedSize": "5.1MB"
    }
  }
}
```

--------------------------------

### GET /api/browse/publishers/{slug}

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Browse games filtered by a specific publisher slug.

```APIDOC
## GET /api/browse/publishers/{slug}

### Description
Browse games by publisher.

### Method
GET

### Endpoint
/api/browse/publishers/{slug}

### Parameters
#### Path Parameters
- **slug** (string) - Required - The publisher slug
```

--------------------------------

### GET /api/browse/genres/{slug}

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Browse games filtered by a specific genre slug.

```APIDOC
## GET /api/browse/genres/{slug}

### Description
Browse games by genre.

### Method
GET

### Endpoint
/api/browse/genres/{slug}

### Parameters
#### Path Parameters
- **slug** (string) - Required - The genre slug

#### Query Parameters
- **page** (number) - Optional - Page number
- **limit** (number) - Optional - Results per page
```

--------------------------------

### Format and check code style

Source: https://github.com/xtreemmak/ggrequestz/blob/main/CONTRIBUTING.md

Use these commands to format your code or verify that it meets the project's formatting standards as enforced by CI.

```bash
# Format code (this is also the "fix" command)
npm run format

# Check formatting, as CI does
npm run lint

# Type-check Svelte components
npm run check
```

--------------------------------

### Configure optional services in .env

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/setup/QUICKSTART.md

Environment variables to enable RomM integration, Gotify notifications, and outbound webhooks.

```bash
# ROMM Integration
ROMM_SERVER_URL=http://your-romm-server
# Recommended for RomM 5.0+: a Client API Token with the "roms.read" scope.
# It does not expire and avoids storing your password.
ROMM_API_TOKEN=your_client_api_token
# Fallback for RomM 4.x:
#ROMM_USERNAME=your_username
#ROMM_PASSWORD=your_password

# Gotify Notifications
GOTIFY_URL=http://your-gotify-server
GOTIFY_TOKEN=your_token

# Outbound request webhook (any JSON receiver)
REQUEST_WEBHOOK_URL=https://your-webhook-endpoint
```

--------------------------------

### Run database migrations

Source: https://github.com/xtreemmak/ggrequestz/blob/main/CHANGELOG.md

Command to execute database migrations manually.

```bash
npm run db:migrate
```

--------------------------------

### Project Directory Layout

Source: https://github.com/xtreemmak/ggrequestz/blob/main/src/tests/README.md

The file structure for the unit and integration testing projects.

```text
src/tests/                          # the "unit" Vitest project (jsdom)
├── README.md
├── setup.js                        # browser API mocks
├── mocks/
│   └── env.js                      # $env/dynamic/private stub
└── unit/
    ├── auth-utils.test.js          # isAuthenticated, display name, initials
    ├── basic-auth-token.test.js    # session token signing
    ├── performance.test.js         # prefetch, metrics, image/bundle helpers
    └── utils-direct.test.js        # truncateText, formatDate, safeAsync, withTimeout

tests/                    # everything outside src/
├── integration/                    # the "integration" Vitest project (node)
│   └── romm-token-lifecycle.test.js
├── e2e/                            # Playwright
│   ├── global-setup.js             # refuses to run without the test stack
│   ├── helpers.js                  # signIn(), seeded credentials
│   ├── auth.spec.js
│   └── homepage.spec.js
└── fixtures/
    └── games.json                  # seed data for the Docker stack
```

--------------------------------

### GET /api/games/popular

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Retrieve a list of popular games with optional pagination and content filtering.

```APIDOC
## GET /api/games/popular

### Description
Fetches a list of popular games. Supports pagination and user-based content filtering.

### Method
GET

### Endpoint
/api/games/popular

### Parameters
#### Query Parameters
- **page** (number) - Optional - Page number
- **limit** (number) - Optional - Items per page
- **user_id** (string) - Optional - User ID for applying content filters
```

--------------------------------

### GET /api/search

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Search for games based on a query string. Supports pagination parameters.

```APIDOC
## GET /api/search

### Description
Search for games using a query string. Supports pagination parameters like page and limit.

### Method
GET

### Endpoint
/api/search

### Parameters
#### Query Parameters
- **q** (string) - Required - The search query string
- **page** (number) - Optional - Page number (starts at 1)
- **limit** (number) - Optional - Items per page (max: 100)
- **per_page** (number) - Optional - Items per page (max: 100)
```

--------------------------------

### Create manual release tags

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/guides/RELEASE_GUIDE.md

Alternative method to create a release by manually updating the package version and pushing git tags.

```bash
# Update package.json version
npm version 1.0.3

# Create and push the tag
git tag v1.0.3
git push origin main
git push origin v1.0.3
```

--------------------------------

### GET /api/watchlist/status/{id}

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Checks if a specific game is currently in the user's watchlist.

```APIDOC
## GET /api/watchlist/status/{id}

### Description
Check if game is in user's watchlist.

### Method
GET

### Endpoint
/api/watchlist/status/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The IGDB ID of the game
```

--------------------------------

### GET /api/games/popular Response

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/API.md

Returns a list of popular games from IGDB with pagination support.

```json
{
  "success": true,
  "games": [
    {
      "igdb_id": "72129",
      "title": "The Legend of Zelda: Breath of the Wild",
      "cover_url": "https://images.igdb.com/igdb/image/upload/t_cover_big/co1nqg.jpg",
      "rating": 97.5,
      "popularity_score": 98.2,
      "platforms": ["Nintendo Switch", "Wii U"],
      "genres": ["Adventure", "Role-playing (RPG)"]
    }
  ],
  "hasMore": true,
  "total": 1000
}
```

--------------------------------

### Run release helper script

Source: https://github.com/xtreemmak/ggrequestz/blob/main/docs/guides/RELEASE_GUIDE.md

Use the npm script or the shell script directly to automate the release process for a specific version.

```bash
# Create a release for version 1.0.3
npm run release 1.0.3
```

```bash
scripts/create-release.sh 1.0.3
```
Tokens:
Raw