Skip to content

terai-labs/terai

Repository files navigation

cover


Build Tests Coverage Language License

Terai is a i18n framework for Typescript applications. Built for the open source community and optimized for developer experience in the frameworks you love.

Warning

Terai is currently in development preview with unstable dependencies. While not planned, we may need to introduce breaking changes in these dependencies on the road to v1.0.

Introduction

Terai is a developer-first open-source localization framework for JavaScript that aims to remove the pain in the localization process.

Workflow can be broken down into 3 steps:

  • 1️⃣ Develop: incorporate your translation source messages into your project using our dedicated SDKs.
  • 2️⃣ Extract: streamline your extraction process by automatically gathering all the messages within your project.
  • 3️⃣ Translate: use your defined translator to get your localized messages.

More documentation available at https://terai-labs.github.io/terai.

Quick Demo

demo

Features

  • πŸš€ Speed: Remove the pain in the localization process. Translate your products 10x faster.
  • πŸ§‘β€πŸ’» Developer-focused: One of our main goal was improving the developer experience. No more looking for keys in your source code, no more editing localisation files, and no more manual exporting data for translators.
  • πŸ† Javascript-based: designed to be used in any javascript-based environment with specific integrations for all major frameworks: Node, React, Next...
  • πŸ€– Translation: Let the machines work for you. We natively support ChatGPT, Google Translate (and more to come), or use your custom translation service.
  • πŸ•‹ Cache: Don’t translate the same string twice. Translation cache reuses strings you’ve already translated.
  • 🌱 Lightweight: offer your product to your audience in the way they understand better with just a few KB.
  • βœ‚οΈ Code splitting: Split your translation files with ease. Just import the messages your user needs to see.
  • πŸ’Ž TypeScript: Full-written in TypeScript.
  • ⭐️ MIT Licensed: Free for personal and commercial use.

Packages

Package Description Version Size Downloads
@terai/dev Dev package for Terai Version Size NPM
@terai/react Terai for React.js Version Size NPM
@terai/next Terai for Next.js (WIP) Version Size NPM
@terai/node Terai for Node.js Version Size NPM

Getting Started

Visit https://terai-labs.github.io/terai to get started with Terai.

Documentation

Visit https://terai-labs.github.io/terai/docs to view the full documentation.

Community

The Terai community can be found on GitHub Discussions, where you can ask questions, voice ideas, and share your projects.

Our Code of Conduct applies to all Terai community channels.

Contributing

Please see our contributing.md.

Good First Issues

We have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

Authors

License

MIT License Β© 2023-Present Hugo Corta