VOICEVOX

VOICEVOX のフロントエンド。（音声合成エンジンは VOICEVOX ENGINE へ）

環境構築

.node-versionに記載されているバージョンの Node.js をインストールしてください。インストール後、次のコマンドを実行してください。

npm ci

実行

.env.productionをコピーして.envを作成し、ENGINE_PATHにvoicevox_engineがあるパスを指定します。とりあえず製品版 VOICEVOX のディレクトリのパスを指定すれば動きます。

npm run electron:serve

音声合成エンジンのリポジトリはこちらです https://github.com/Hiroshiba/voicevox_engine

貢献者の方へ

Issue を解決するプルリクエストを作成される際は、別の方と同じ Issue に取り組むことを避けるため、 Issue 側で取り組み始めたことを伝えるか、最初に Draft プルリクエストを作成してください。

ビルド

npm run electron:build

コードフォーマット

コードのフォーマットを整えます。プルリクエストを送る前に実行してください。

npm run fmt

タイポチェック

typosを使ってタイポのチェックを行っています。 typos をインストールした後

typos

でタイポチェックを行えます。もし誤判定やチェックから除外すべきファイルがあれば設定ファイルの説明に従って_typos.tomlを編集してください．

Markdownlint

Markdown の文法チェックを行います。

npm run markdownlint

OpenAPI generator

音声合成エンジンが起動している状態で以下のコマンドを実行してください。

curl http://127.0.0.1:50021/openapi.json >openapi.json

$(npm bin)/openapi-generator-cli generate \
    -i openapi.json \
    -g typescript-fetch \
    -o src/openapi/ \
    --additional-properties=modelPropertyNaming=camelCase,supportsES6=true,withInterfaces=true,typescriptThreePlus=true

npm run fmt

ライセンス

LGPL v3 と、ソースコードの公開が不要な別ライセンスのデュアルライセンスです。別ライセンスを取得したい場合は、ヒホ（twitter: @hiho_karuta）に求めてください。

ssmxgo/voicevox