Skip to content

docs: document how to add a new language #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
spathon merged 4 commits into from
Mar 5, 2026
Merged

docs: document how to add a new language #16

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bb0b090
docs: document how to add a new language
wfrsilva Mar 2, 2026
6df99a9
Merge branch 'spathon:main' into docs/add-language-guide
wfrsilva Mar 3, 2026
6c8baa8
Merge branch 'main' into docs/add-language-guide
spathon Mar 4, 2026
5f505ae
docs: update lng guide after i18n simplification
wfrsilva Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,23 @@ Understand how joins work by interacting and see it visually
* `cd Visual-JOIN`
* `npm install`
* `npm run dev`



## Adding a new language

To add a new language:

1. Create a file under `src/i18n/locales/` (see `pt.ts` as an example).

2. Implement all required keys from the `Translations` type.

3. Register the locale in `src/i18n/types.ts`:

```ts
export const SUPPORTED_LOCALES = ['en', 'es', 'fr', 'de', 'sv', 'pt'] as const

export const LOCALES = {
...
pt: 'Português',
}