@genesys225/tolgee-web

Tolgee JS Web
The base of Tolgee JS integrations for Web platform

Tolgee is an open-source alternative to Crowdin, Phrase, or Lokalise with its very own revolutionary integrations.

Become part of the family. Join slack channel

What is Tolgee JS Web?

It's the core library of Tolgee JS integrations containing the parts supporting the web platform. For more information about Tolgee JS integrations, visit the docs.

Quick links

• Tolgee JS SDK docs
• Tolgee Website
  • Product (Learn more about the great features)
    • Dev tools
    • Translation assistance
    • Collaboration
• Integrations (Learn how to integrate Tolgee with your favorite technology)
  • React
  • Angular
  • Vue
  • Svelte
  • Next.js
  • More...
• Tolgee platform docs

Installation

npm install @tolgee/web

Usage

First, create a Tolgee instance and run it.

import { Tolgee, DevTools, FormatSimple } from "@tolgee/web";

const tg = Tolgee()
  .use(DevTools())
  .use(FormatSimple())
  .init({
    apiKey: "your_api_key",
    apiUrl: "https://app.tolgee.io",
  })

tg.run();

Then, use it to translate your strings.

tg.onLangLoaded.subscribe(() => {
  document.title = tg.translate("hello_world");
});

Why to use Tolgee?

Because it saves a lot of time, you would spend on localization tasks without it. Because it enables you to provide perfectly translated software.

Features

• All-in-one localization solution for your JS application 🙌
• Out-of-box in-context localization 🎉
• Automated screenshot generation 📷
• Translation management platform 🎈
• Open-source 🔥

Read more on the Tolgee website

Development

We welcome your PRs.

To develop the package locally:

1. Clone the repository
2. Install the packages in the repository root

pnpm install

1. Run web or any integration development script

pnpm develop:react

or

pnpm develop:web

This runs the development suite of this monorepo for the specific integration. The changes in each dependency package are automatically built and propagated to the test application, which you can open and play within the browser.

Testing

To run Jest tests of this package, execute

npm run test

In the /packages/core directory.

End-to-end (e2e) testing

Each integration is end-to-end tested via cypress. The tests are defined in /e2e/cypress/e2e directory.

To run the e2e tests, simply run the following:

pnpm run e2e run <integration>

E.g.

pnpm run e2e run web

To open and play with e2e tests, run:

pnpm run e2e open <integration>

Contributors