@mi18n/core

Mi18n JS Core
The Core of Mi18n JS integrations

Mi18n 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 Mi18n JS Core?

It's the core library of Mi18n JS integrations containing the platform-agnostic parts of the Mi18n JS. For more information about Mi18n JS integrations, visit the docs.

Quick links

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

You should not use this package directly for usage in the web browser

If you use Mi18n on the web, use @mi18n/web package, which extends this package with web-related functionality.

This package is platform-agnostic, so it contains only the most general functionality.

Installation

npm install @mi18n/core

Usage

First, create a Mi18n instance and run it.

import { Mi18nCore } from "@mi18n/core";

const tg = Mi18nCore()
  .use(...)
  .init(...)

tg.run();

To learn more, check the docs.

Why to use Mi18n?

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 Mi18n website

Development

We welcome your PRs.

To develop the package locally:

• Clone the repository
• Install the packages in the repository root

pnpm install

• 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, run

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