Tolgee JS Web
The base of Tolgee JS integrations for Web platform
[](https://tolgee.io)
Tolgee is an open-source alternative to Crowdin, Phrase, or Lokalise
 
[](https://github.com/tolgee/tolgee-js)
[](https://github.com/tolgee/tolgee-platform)
[](https://github.com/tolgee/tolgee-platform/discussions)
[](https://hub.docker.com/repository/docker/tolgee/tolgee)
[](https://docs.tolgee.io/)
[](https://join.slack.com/t/tolgeecommunity/shared_invite/zt-2zp55d175-_agXTfKKVbf1BYXlKlmwbA)
[](https://dev.to/tolgee_i18n)
[](https://www.youtube.com/@tolgee)
[](https://www.linkedin.com/company/tolgee/)
[](https://x.com/Tolgee_i18n)
## 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](https://tolgee.io/js-sdk/5.0.0-alpha.1/).
## Quick links
- [Tolgee JS SDK docs](https://tolgee.io/js-sdk)
- [Tolgee Website](https://tolgee.io)
- Product (Learn more about the great features)
- [Dev tools](https://tolgee.io/features/dev-tools)
- [Translation assistance](https://tolgee.io/features/translation-assistance)
- [Collaboration](https://tolgee.io/features/collaboration)
- Integrations (Learn how to integrate Tolgee with your favorite technology)
- [React](https://tolgee.io/integrations/react)
- [Angular](https://tolgee.io/integrations/angular)
- [Vue](https://tolgee.io/integrations/vue)
- [Svelte](https://tolgee.io/integrations/svelte)
- [Next.js](https://tolgee.io/integrations/next)
- [More...](https://tolgee.io/integrations/all)
- [Tolgee platform docs](https://tolgee.io/platform)
## Installation
```
npm install @tolgee/web
```
## Usage
First, create a Tolgee instance and run it.
```ts
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.
```ts
tg.onLangLoaded.subscribe(() => {
document.title = tg.translate("hello_world");
});
```
## Why to use Tolgee?
Tolgee saves a lot of time you would spend on localization tasks otherwise. 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](https://tolgee.io)
## Development
We welcome your PRs.
To develop the package locally:
1. Clone [the repository](https://github.com/tolgee/tolgee-js)
1. 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
```
E.g.
```
pnpm run e2e run web
```
To open and play with e2e tests, run:
```
pnpm run e2e open
```
## Contributors
