Skip to content

homeputers/gamearr

gamearr

CI Docker API Docker Worker Docker Web Docs

Monorepo managed with Turborepo and pnpm.

Usage Disclaimer

gamearr does not provide game files. Use this project only with backups of games you legally own. You are responsible for complying with the terms of service for any providers you access through this software.

Workspaces

  • apps/api – NestJS API server
  • apps/worker – background worker built with Nest
  • apps/web – React app bootstrapped with Vite and TypeScript
  • packages/domain – shared domain logic in TypeScript
  • packages/adapters – provider and download clients
  • packages/storage – Prisma client and migrations
  • packages/shared – zod schemas, logger, and config utilities

Infrastructure

Requires Docker Compose to be installed.

Copy .env.example to .env and set the POSTGRES_PASSWORD value. Then start the supporting services:

docker compose -f infra/docker-compose.yml up -d

Data is persisted to the data/ directory.

Development

pnpm -w install
pnpm -w dev

Build

pnpm -w build

Release

  1. Ensure all changes have an associated changeset.

  2. Run the changelog task to apply version bumps and regenerate CHANGELOG.md:

    make changelog
  3. Commit the result and create a tag:

    git commit -am "chore(release): vX.Y.Z"
    git tag vX.Y.Z
    git push origin --tags

The release workflow builds and publishes artifacts for the tagged version.

Documentation

Additional guides and references live in the docs directory.

About

ServArr for games

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors