Skip to content

Latest commit

 

History

History
183 lines (118 loc) · 8.35 KB

README.md

File metadata and controls

183 lines (118 loc) · 8.35 KB
Logo

Taibun

Contributors Licence LinkedIn

Taiwanese Hokkien Transliterator and Tokeniser

App to customise transliteration and retrieve any necessary information about Taiwanese Hokkien pronunciation.

Live Demo


Table of Contents
  1. About The Project
  2. Install
  3. Features
  4. Lighthouse Report
  5. Contributors
  6. Acknowledgements
  7. Licence

About The Project

Taibun is a comprehensive tool for transliterating and tokenising Taiwanese Hokkien. Developed as a demo for the Taibun library, this web application showcases its capabilities by allowing users to customise the transliteration of Chinese characters and retrieve detailed pronunciation information.

The application is designed to streamline the process of transliterating and tokenising Taiwanese Hokkien text, providing users with a user-friendly interface and a variety of customisation options that are supported by Taibun.

Built With

  • React
  • Vite
  • Mantine
  • Taibun

Install

Run the app locally:

$ npm install
$ npm run dev

The website can be accessed through the URL http://localhost:5173/.

Features

Transliterator

Transliterator Page allows users to convert Chinese characters to the chosen transliteration system with customisable parameters such as system, dialect, tone format, delimiter, sandhi rules, and punctuation style.

Transliterator

Tokeniser

Tokeniser Page performs tokenisation of Taiwanese Hokkien sentences, breaking down the text into individual words or tokens.

Tokeniser

Set Converter

Set Converter Page converts text between Simplified and Traditional Chinese characters for Taiwanese Hokkien.

Set Converter

Localisation

Users can switch between English, Taiwanese, and Mandarin from the language selector in the Navbar.

Taiwanese Mandarin

Lighthouse Report

Audit

Contributors

Acknowledgements

  • Samuel Jen (Github · LinkedIn) - Taiwanese and Mandarin localisation

Licence

Because Taibun is MIT-licensed, any developer can essentially do whatever they want with it as long as they include the original copyright and licence notice in any copies of the source code.