Loqui is a free and open-source platform that makes translating Minecraft mods easy through crowdsourcing. It's a powerful alternative to Lokalise & Crowdin with deep Modrinth integration.
Developers can easily manage translations with automatic updates and Modrinth OAuth integration, translators have user-friendly tools and earn community recognition and players enjoy seamless access to mods in their own languages through automatic updates or resource packs.
Welcome to the repository containing all the code and resources to make
Loqui work. The two most important branches you will find here are dev
and prod
. The dev
branch contains code that is currently worked on
and isn't live in a production environment. However, you can still check
out development progress on our staging deployment. Stable code that is
used in production is located in the prod
branch; eventually, code
from the dev
branch finds its way here.
-
Clone the repository:
git clone https://github.com/The-Loqui-Project/Loqui.git cd loqui
-
Install dependencies:
pnpm install
-
Set up environment variables: Copy the
.env.example
files inapps/web
andapps/api
to.env
and fill in the required values. -
Initialize the local test database:
cd apps/api pnpm run dev:test-db:setup pnpm run dev:test-db pnpm run db:push
-
Start the development servers: From the root directory:
pnpm run dev
This will concurrently start both the frontend and backend applications.
We welcome contributions from the community! To get started:
-
Fork the repository and create your branch from
dev
:git checkout -b feature/your-feature
-
Make your changes.
-
Run tests to verify your changes:
pnpm test
-
Commit your changes with a clear message, adhering to the Conventional Commitsstandard:
git commit -m "feat: Add new feature"
-
Push to your fork and submit a pull request to the
dev
branch; the name of your PR should, like your commit messages, stick to the Conventional Commits format.
This project is licensed under the GPLv3/LGPLv3.