README.md

自動点訳ソフトウェア Translate Braille

English README is here.

これは、自動点訳ソフトウェア Translate Braille です。

目次

• 概要
• 使い方
• 開発
  • 要件
  • 推奨
  • 環境構築
  • 開発用サーバーの起動
  • コミット前
• コントリビューション

概要

これは、自動点字翻訳ソフトウェア Translate Braille です。

使い方

この Web アプリケーションを使用するには、ここにアクセスしてください。

開発

要件

• npm
• Python 3

推奨

• VS Code 拡張機能
  • Prettier
  • Black

環境構築

このリポジトリをクローンしてから、プロジェクトのルートディレクトリに移動し、以下のコマンドを実行してください。

npm run setup

開発用サーバーの起動

開発用サーバーを起動するには、以下のコマンドを実行してください。そうすると、http://localhost:5173/ でアプリケーションにアクセスできます。

npm run dev

コミット前

コミット前には、以下のコマンドを実行して、コードスタイルと型のチェックを行ってください。

npm run format && npm run type-check

コントリビューション

Issue や PR などはいつでも歓迎します。

参考資料

https://atmarkit.itmedia.co.jp/ait/articles/2102/05/news027_2.html

https://github.com/tadd/braille-ja-table