# General Translation Platform: Quickstart
URL: https://generaltranslation.com/en-US/docs/platform/locadex/quickstart.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: Use Locadex, the AI agent which connects your codebase, translations, and content sources. It’s the fastest way to run General Translation's full-stack localization.

Locadex is the General Translation AI agent which connects your codebase, translations, and content sources.

After setup, Locadex can configure your project and automatically translate it into the languages you choose.

Locadex currently supports **Next.js**, **Mintlify**, **Fern**, and **Docusaurus** projects, along with React applications built with Vite, Gatsby, Redwood, React Router, TanStack Start, Bazel, esbuild, Rollup, Rolldown, or webpack.

## How Locadex works [#locadex-works]

Locadex works inside your GitHub repository and automatically opens or updates PRs with generated changes. Three automation templates keep your localization up to date:

- **Generate code** wraps source code with the right internationalization (i18n) library calls, such as `t()` and the `T` component.
- **Generate translations and push** translates source content into every target language and updates translation files.
- **Keep locales in sync** updates project files when languages are added or removed.

Each automation can run manually, when a pull request changes, or when a commit is pushed. You choose the trigger settings.

## Quickstart [#quickstart]

Before you start, you need a [General Translation](https://dash.generaltranslation.com) project on a Starter, Team, or Enterprise plan and a GitHub repository containing a project built with one of Locadex's supported frameworks. Creating and running project automations requires `project:locadex:write` permission.

1. **Connect GitHub.** Open your project from the [Dashboard](https://dash.generaltranslation.com), go to **Project > Integrations > Catalog**, and connect GitHub. Choose the repository Locadex should use for this project.
2. **Create an automation.** Open **Project > Automations**. Under **Start with a template**, choose **Generate code**, **Generate translations and push**, or **Keep locales in sync**.
3. **Choose the target.** Select the linked repository, target directory, and detected framework. Use `.` when the app is at the repository root.
4. **Review the automation.** Choose the target branch, trigger, created branch prefix, auto-merge behavior, changed-file filtering, and whether to preserve local edits. Click **Create automation**.
5. **Run setup.** Open the automation and click **Run setup**. Choose the source locale and target languages. Locadex prepares the repository and opens a setup pull request.
6. **Review and merge.** Open the setup pull request from the automation page, review the changes, and merge it before running the automation.

After the setup PR is merged, each automation follows its configured trigger. For an automatic run, Locadex reuses the open pull request for the same source branch and automation, then opens a new one after that pull request is merged or closed. Review PRs or **enable [auto-merge](/docs/platform/locadex/guides/auto-merging-prs)** and your app stays translated without manual work.

Open an automation and click **Run now** to trigger it manually.

## Next steps

- /docs/platform/locadex/guides/configuring-automations
- /docs/platform/locadex/guides/managing-languages
- /docs/platform/locadex/guides/auto-merging-prs
- /docs/platform/locadex/guides/viewing-automation-activity

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.
