https://github.com/uncomputable/konbaato

Convert between different Japanese scripts
https://github.com/uncomputable/konbaato

hiragana japanese kana kanji katakana

Last synced: about 1 month ago
JSON representation

Convert between different Japanese scripts

• Host: GitHub
• URL: https://github.com/uncomputable/konbaato
• Owner: uncomputable
• License: cc0-1.0
• Created: 2024-06-04T20:57:49.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-06-05T20:37:06.000Z (over 1 year ago)
• Last Synced: 2025-02-04T19:46:37.786Z (8 months ago)
• Topics: hiragana, japanese, kana, kanji, katakana
• Language: Rust
• Homepage: https://uncomputable.github.io/konbaato/
• Size: 50.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Konbaato・コンバート

[![GitHub](https://img.shields.io/badge/github-repo-blue.svg)](https://github.com/uncomputable/konbaato)

[![crates.io](https://img.shields.io/crates/v/konbaato.svg)](https://crates.io/crates/konbaato)

[![docs.rs](https://docs.rs/konbaato/badge.svg)](https://docs.rs/konbaato)

[![CI](https://github.com/uncomputable/konbaato/actions/workflows/test.yml/badge.svg)](https://github.com/uncomputable/konbaato/actions/workflows/test.yml)

Convert between different Japanese scripts.

Ready for WASM 🌀

[A live demo is running on GitHub Pages](https://uncomputable.github.io/konbaato/).

## Use the crate in Rust

Include the latest version of `konbaato` in your `Cargo.toml`.

```toml

[dependencies]

konbaato = "1.0"

```

## Install nix

Use the following command to install nix if you don't already have it.

```bash

curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install

```

_You might need to open a new terminal for the changes to take effect._

## Use the crate in JavaScript

Build the WASM package inside the developer shell for deployments.

```bash

nix develop .#deploy

just wasm

```

Import the output in `./pkg` in JavaScript, as shown in [index.html](https://github.com/uncomputable/konbaato/blob/master/index.html).

```js

import init, { hira_to_kata } from './pkg/konbaato.js';

async function run() {

    await init();

    const input = "ひらがな";

    const output = hira_to_kata(input);

}

run()

```

## Develop the crate

Run CI inside the default developer shell.

```bash

nix develop

just check

```

Deploy a local website.

```bash

nix develop

just serve

```

Run the fuzzer inside the develper shell for fuzzing.

```bash

nix develop .#fuzz

just fuzz

```