ringoyaki(りんご焼き)は、SCJ共通りんご文の翻訳を手軽に表示させることができるツールです。
ringoyakiはSCJ共通りんご文と同じく開発途中です。 あらかじめご了承ください。
- SCJ共通りんご文を翻訳したものがブラウザに美しく描画されます。
- 画一されたデザインのため、他の言語で翻訳されたりんご文と見比べやすいです。
- 編集しながら、出来具合を確認することができます。
- 翻訳されていない部分は描画されないため、未完成でも見やすいです。
- 手軽にそのままの状態でWebページとしてインターネット上に公開することができます。
git clone https://github.com/CL-KIITA/ringoyakiでリポジトリをクローンします。cd ringoyakiでリポジトリ内に移動して、npm installでパッケージの復元をします。npm run startでコンパイルします。ブラウザが表示されれば成功です。
実際に導入するときは、GitHub Pagesでウェブサイトをインターネット上に公開することを見据えて、GitHubアカウントを作っておきましょう。
- https://github.com/CL-KIITA/ringoyaki へ行きます。
- Forkボタンを押して、フォークしたいアカウントを選択し、フォークします。
- リポジトリ名を適宜変更します。
git clone https://github.com/(username)/ringoyakiをしてフォークしたあなたのリポジトリをクローンします。(username)にはユーザ名を入力してください。cd ringoyakiでリポジトリ内に移動して、npm installでパッケージの復元をします。npm run startでコンパイルします。ブラウザが表示されればコンパイルが成功しました。- この状態で
./src/data/translation.jsonをSCJ共通りんご文のドキュメントを見ながら訳していきます。translationのところにidに対応した翻訳文を埋めていきます。- ファイルを保存するたびに、webpackの機能で自動的にリビルトします。保存して、ウェブページが更新されていくのを確認しましょう。
translationが空文字列の場合は表示されないため、未翻訳の部分はそのまにしておきましょう。
- 終了する際はターミナルにCtrl + Cを入力します。
./package.jsonのhomepageの14行目くらいにあるhttps://CL-KIITA.github.io/ringoyakiをhttps://(username).github.io/ringoyakiに変更します。npm run deployをします。- パスワードが聞かれたり認証を求められたりしたら適宜対応します。
https://(username).github.io/ringoyakiにアクセスして、公開されていたら成功です。やったね!ちなみに、この処理には15分ほどかかるので、コーヒーでも飲みながら気長に待ちましょう。
上級者向けです。(いまいちDockerに慣れていないので、もし改善できるところがあったらプルリクください♡)
以下の通りにコマンドを打ってください。
$ git clone https://github.com/CL-KIITA/ringoyaki
$ cd ringoyaki
$ docker-compose build
$ docker-compose up