Skip to content

LEADR is the open-source, cross-platform leaderboards backend for indie game devs.

License

Notifications You must be signed in to change notification settings

LEADR-official/leadr-oss

Repository files navigation

LEADR - Cross-platform Leaderboards for Game Devs

GitHub Tag GitHub commit activity Tests Passing License

Cross-platform leaderboards for game developers. Add feature-rich leaderboards to your game on any platform, any engine, and unify all your players in one place. Open-source, with built-in anti-cheat and more, without trying to be your entire backend.

New to LEADR? Follow the Quick Start guide to create your account and set up your first leaderboard.

Game Features

  • Cross Platform - No need to individually integrate Steam Workshop, Unity Cloud, Google Play Services...
  • Developer Friendly - The best docs. The clearest SDKs. Actual interest in the community
  • Anti-cheat by Default - Secure and sophisticated server implementation to minimise and help triage abuse
  • We Do Leaderboards - Different modes, levels, difficulties, geographies, units, sorting and more
  • Seasons & Temporary Boards - Automated leaderboards that reset or disable based on date & time
  • More Than Just Scores - Store replay data, share live-updating web pages, track player progress and more

Software Features

  • Open-Source Core - LEADR's cloud service is built on this very same open-source core
  • Fully documented - Clear, complete, developer-friendly docs
  • Docker Ready - Deploy to any cloud platform in minutes
  • Secure & Scalable - Built to the latest industry standards by expert backend software developers (sadly we're better at making web apps than games)

Tip

Don't want the hassle of deploying it yourself? Get started for free at https://docs.leadr.gg/latest/quick-start

LEADR Cloud Features

  • Free Tier Available - Start in seconds at no cost, only pay when you need studio-grade features
  • Scales With Your Audience - LEADR's infrastructure is ready for your game to go viral
  • Beautiful Web Views - Make your leaderboards visible, with auto-generated, shareable, modern pages
  • More coming soon - LEADR is under active development and we've got lots planned...

Quick Start

LEADR Cloud

Follow the Quick Start guide to create your account and first leaderboard.

Think docs are overated? Download LEADR app and forge your own path:

Windows: Download the LEADR App

macOS / Linux:

curl -sSL https://leadr.gg/download/install.sh | bash

Self-host

Deploy our prebuilt & production-ready image to your preferred cloud host:

ghcr.io/LEADR-official/leadr-oss:latest

See the self-hosting docs for configuration and deployment guides.

What's Next


Developer Documentation

Local Development

...

Docker Build

# Build image
docker buildx build -t leadr-api --load .

# Run locally
docker run -p 3000:3000 \
  -e SUPERADMIN_API_KEY=ldr_your_secret_key \
  leadr-api

Database Management

LEADR uses PostgreSQL and supports both local development databases and managed PostgreSQL services (LEADR Cloud uses Neon.

Using External PostgreSQL (Recommended for Production)

When using Neon's managed PostgreSQL, configure two endpoints:

# Pooled endpoint for connections using PgBouncer
DB_HOST=your.public.db.endpoint

# Direct endpoint used by migrations (bypasses PgBouncer)
DB_HOST_DIRECT=your.public.db.endpoint

Running Migrations

# Apply all pending migrations
uv run alembic upgrade head

# Check migration status
uv run alembic current

Documentation Generation

...

Release Process

This project uses automated semantic versioning:

  1. See what's changed: git log <v tag>..HEAD && git diff <v tag> HEAD --stat
  2. Decide whether the release is a patch, minor or major version
  3. Go to Actions → Release and Publish
  4. Click "Run workflow"
  5. The workflow will:
    • Analyze commits to determine version bump
    • Create a GitHub release
    • Build and push Docker images to GitHub Container Registry

Contributing

We follow test-driven development:

  1. Create a branch
  2. Write tests first
  3. Implement features
  4. Ensure all tests pass
  5. Ensure all CI checks pass
  6. Make a PR

Need Help?


Built with ❤️ for the indie game dev community

Umami pixel

About

LEADR is the open-source, cross-platform leaderboards backend for indie game devs.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 2

  •  
  •  

Languages