# Translately

> Open-source, MIT-licensed, self-hosted localization and translation management platform. v0.3.0 shipped today (MVP end): keys + translations + ICU validation + i18next JSON import/export. Quarkus + Kotlin backend, React + Vite webapp, PostgreSQL + Redis + MinIO. Bring-your-own-key AI lands in v0.4.0 and is entirely optional — the platform runs end-to-end without it. Every "premium" feature (SSO, SAML, LDAP, Tasks, Branching, Glossaries, Webhooks, CDN, audit) ships free.

The canonical LLM-ingestible corpus for Translately's documentation, generated from the `docs/` tree per the [llmstxt.org](https://llmstxt.org) standard. Regenerate with `scripts/gen-llms-txt.sh` whenever `docs/` changes — CLAUDE.md rule #10 requires it.

## Getting started

- [Home](https://pratiyush.github.io/translately/): Positioning, what ships today, roadmap
- [Quickstart](https://pratiyush.github.io/translately/quickstart/): 10-minute path from `docker compose up` to first exported JSON

## Product

- [Product docs index](https://pratiyush.github.io/translately/product/): User-visible feature walkthroughs
- [Application shell](https://pratiyush.github.io/translately/product/app-shell/): Nav, org switcher, user menu, routing
- [Theming](https://pratiyush.github.io/translately/product/theming/): Light / dark / system toggle + persistence
- [Authentication](https://pratiyush.github.io/translately/product/auth/): Signup, email verify, login, password reset
- [Organizations and projects](https://pratiyush.github.io/translately/product/organizations-and-projects/): Multi-tenant org + project surface with role management
- [Keys, namespaces, translations](https://pratiyush.github.io/translately/product/keys-and-translations/): Translation table, autosave editor, key + namespace CRUD
- [Imports and exports](https://pratiyush.github.io/translately/product/imports-and-exports/): i18next JSON import wizard + export modal
- [API keys & Personal Access Tokens](https://pratiyush.github.io/translately/product/api-keys-and-pats/): Long-lived credentials for server-to-server + CLI

## API

- [API overview](https://pratiyush.github.io/translately/api/): Conventions, error envelope, pagination, IDs
- [OpenAPI 3.1 spec](https://pratiyush.github.io/translately/api/openapi.json): Machine-readable source of truth
- [Scopes](https://pratiyush.github.io/translately/api/scopes/): Permission scope matrix
- [Error codes](https://pratiyush.github.io/translately/api/errors/): Stable `error.code` catalogue
- [Rate limits](https://pratiyush.github.io/translately/api/rate-limits/): Per-token and per-endpoint policy
- [Versioning](https://pratiyush.github.io/translately/api/versioning/): URL-path versioning + deprecation policy
- [Authentication endpoints](https://pratiyush.github.io/translately/api/auth/): HTTP-level walkthrough of /auth/*
- [Organizations, projects, members](https://pratiyush.github.io/translately/api/organizations-and-projects/): Tenant + project CRUD + role endpoints
- [Keys and namespaces](https://pratiyush.github.io/translately/api/keys-and-namespaces/): Translation-key CRUD + per-cell upsert
- [Imports and exports](https://pratiyush.github.io/translately/api/imports-and-exports/): i18next JSON import + export endpoints

## Architecture

- [Architecture index](https://pratiyush.github.io/translately/architecture/): Module map + system overview
- [ADR index](https://pratiyush.github.io/translately/architecture/decisions/): All accepted decision records
- [Module map](https://pratiyush.github.io/translately/architecture/modules/): 13-module Gradle graph + ownership
- [Data model](https://pratiyush.github.io/translately/architecture/data-model/): ER diagram + relationships + V1 migration story
- [Request lifecycle](https://pratiyush.github.io/translately/architecture/request-lifecycle/): Filter chain + exception mappers
- [Multi-tenancy](https://pratiyush.github.io/translately/architecture/multi-tenancy/): TenantContext + row-level isolation
- [Authentication](https://pratiyush.github.io/translately/architecture/auth/): JWT issuer + rotation
- [Authorization](https://pratiyush.github.io/translately/architecture/authorization/): Scopes + role mapping
- [Crypto](https://pratiyush.github.io/translately/architecture/crypto/): Envelope encryption for BYOK secrets
- [Search](https://pratiyush.github.io/translately/architecture/search/): Postgres FTS + trigram over keys and translations
- [Webapp](https://pratiyush.github.io/translately/architecture/webapp/): SPA stack + state model
- [CI pipelines](https://pratiyush.github.io/translately/architecture/ci/): Six GitHub Actions workflows + branch-protection gates + release pipeline
- [ICU validation](https://pratiyush.github.io/translately/architecture/icu-validation/): MessageFormat parse/validate contract for translation cells

## Self-hosting

- [Self-hosting index](https://pratiyush.github.io/translately/self-hosting/): Operator guides
- [Hardening checklist](https://pratiyush.github.io/translately/self-hosting/hardening/): Production-readiness checklist
- [Dev compose](https://pratiyush.github.io/translately/self-hosting/dev-compose/): Walkthrough of the root `docker-compose.yml` + `compose-prod.yml` diff
- [Runtime profiles](https://pratiyush.github.io/translately/self-hosting/runtime-profiles/): Quarkus %dev / %test / %prod + required env vars + native-image build

## Download

- [Full docs bundle (ZIP)](https://pratiyush.github.io/translately/downloads/translately-docs.zip): Every raw .md / .txt / image under docs/ — offline snapshot of the latest `master`

## Optional

- [Full corpus (single file)](https://pratiyush.github.io/translately/llms-full.txt): Every doc concatenated for one-shot ingestion
- [GitHub repository](https://github.com/Pratiyush/translately): Source code
- [CHANGELOG](https://github.com/Pratiyush/translately/blob/master/CHANGELOG.md): Release history
- [Approved plan](https://github.com/Pratiyush/translately/blob/master/tasks.md): 97-task master list with phase boundaries