Open-source localisation automation platform. It provides a REST API for managing projects, resource files, and translations, with built-in support for change detection, validation, and common localisation file formats.
- Add health view checking DB connection at /health/ - Add curl to Dockerfile.prod for container healthcheck support |
||
|---|---|---|
| apps | ||
| docker | ||
| frontend | ||
| locflow | ||
| parsers | ||
| templates | ||
| .env.example | ||
| .gitignore | ||
| conftest.py | ||
| docker-compose.yml | ||
| Dockerfile | ||
| Makefile | ||
| manage.py | ||
| README.md | ||
| requirements.txt | ||
| setup.cfg | ||
LocFlow
Open-source localization automation platform.
LocFlow streamlines the management of software localization workflows. It provides a REST API for managing projects, resource files, and translations, with built-in support for change detection, validation, and common localization file formats.
Quick Start
- Clone the repository:
git clone https://github.com/your-org/locflow.git
cd locflow
- Copy the environment file and adjust as needed:
cp .env.example .env
- Build and start the services:
make build
make up
- Run database migrations:
make migrate
- Create a superuser:
make createsuperuser
- Access the application:
- API: http://localhost:8000/api/v1/
- Swagger Docs: http://localhost:8000/api/docs/
- Admin Panel: http://localhost:8000/admin/
API Overview
| Endpoint Prefix | Description |
|---|---|
/api/v1/projects/ |
Manage localization projects |
/api/v1/resources/ |
Manage resource files (PO, XLIFF) |
/api/v1/translations/ |
Manage translation entries |
/api/schema/ |
OpenAPI 3.0 schema (JSON) |
/api/docs/ |
Swagger UI interactive documentation |
Development
Run the test suite:
make test
Open a Django shell:
make shell
View logs:
make logs
Roadmap
| Phase | Features | Status |
|---|---|---|
| 1 -- MVP | Upload, parsing, REST API, change detection, validation, Docker | In progress |
| 2 -- Translation Memory | Elasticsearch, fuzzy search for similar strings | Planned |
| 3 -- Auth & Cache | JWT, roles (admin/translator/reviewer), Redis cache | Planned |
| 4 -- Dashboard | Next.js frontend with language progress and translation editor | In progress |
| 5 -- Integrations | Webhooks, CLI tool, Git integration | Planned |
| 6 -- Advanced Pluralization | Full CLDR rules, ICU MessageFormat, advanced validation | Planned |
License
This project is licensed under the MIT License.