Getting Started with Development

This guide will help you set up a local development environment for contributing to Backlog.rip.

Prerequisites

Before you begin, make sure you have the following installed:

Node.js (v18 or later)
npm (v8 or later)
Git

Clone the Repository

First, clone the repository from GitHub:

git clone https://github.com/gsabater/backlog.rip.git
cd backlog.rip

Install Dependencies

Install the project dependencies:

npm install

Configuration

Create a .env file in the root directory with the following variables:

# API Keys
STEAM_API_KEY=your_steam_api_key
IGDB_CLIENT_ID=your_igdb_client_id
IGDB_CLIENT_SECRET=your_igdb_client_secret

# Database
DATABASE_URL=your_database_url

Run the Development Server

Start the development server:

npm run dev

The application will be available at http://localhost:3000.

Building for Production

To build the application for production:

npm run build

Running Tests

To run the test suite:

npm test

Getting Help

If you need help, you can:

Join our Discord community
Open an issue on GitHub
Check our Developer Documentation

On this page

Prerequisites
Clone the Repository
Install Dependencies
Configuration
Run the Development Server
Building for Production
Running Tests
Getting Help

        {
  "title": "",
  "searchDepth": 2,
  "depth": 3,
  "links": [
    {
      "id": "prerequisites",
      "depth": 2,
      "text": "Prerequisites"
    },
    {
      "id": "clone-the-repository",
      "depth": 2,
      "text": "Clone the Repository"
    },
    {
      "id": "install-dependencies",
      "depth": 2,
      "text": "Install Dependencies"
    },
    {
      "id": "configuration",
      "depth": 2,
      "text": "Configuration"
    },
    {
      "id": "run-the-development-server",
      "depth": 2,
      "text": "Run the Development Server"
    },
    {
      "id": "building-for-production",
      "depth": 2,
      "text": "Building for Production"
    },
    {
      "id": "running-tests",
      "depth": 2,
      "text": "Running Tests"
    },
    {
      "id": "getting-help",
      "depth": 2,
      "text": "Getting Help"
    }
  ]
}
        [
  {
    "id": "prerequisites",
    "depth": 2,
    "text": "Prerequisites"
  },
  {
    "id": "clone-the-repository",
    "depth": 2,
    "text": "Clone the Repository"
  },
  {
    "id": "install-dependencies",
    "depth": 2,
    "text": "Install Dependencies"
  },
  {
    "id": "configuration",
    "depth": 2,
    "text": "Configuration"
  },
  {
    "id": "run-the-development-server",
    "depth": 2,
    "text": "Run the Development Server"
  },
  {
    "id": "building-for-production",
    "depth": 2,
    "text": "Building for Production"
  },
  {
    "id": "running-tests",
    "depth": 2,
    "text": "Running Tests"
  },
  {
    "id": "getting-help",
    "depth": 2,
    "text": "Getting Help"
  }
]

        No Table of Contents available