esperecyan/dictionary-wiki

辞書まとめwiki https://game.pokemori.jp/dictionary-wiki/

v0.1.7 2017-10-13 08:22 UTC

README

wiki形式の辞書アップローダーです。 保存は主に単語で答えるゲームにおける汎用的な辞書形式で行い、次のゲーム用の辞書を出力します。

wikiの作成

  1. 本PHPプロジェクトを作成する一つ上のディレクトリに移動します。
    例: cd /var/www
  2. プロジェクトを作成します。
    • 開発用: composer create-project --keep-vcs esperecyan/dictionary-wiki
    • 実運用: composer create-project --no-dev --keep-vcs esperecyan/dictionary-wiki
  3. プロジェクトルートに移動します。 cd dictionary-wiki
  4. 「storage」以下と「bootstrap/cache」以下にApacheから書き込めるようにします。
    chmod --recursive g+w {storage,bootstrap/cache}
    sudo chgrp --recursive apache {storage,bootstrap/cache}
  5. 「.env」ファイルに、データベース設定、辞書検索用にAlgoliaの Application ID と Admin API Key、 OAuthログイン用のクライアントIDとクライアントシークレットを記述します。 実運用環境であれば、キャッシュの作成に利用する APP_URL にwikiトップページのURLを末尾のスラッシュを抜いて記述します。 また、FEED_TAGGING_ENTITY も記述しておきます。
  6. キャッシュを生成し (実運用環境)、マイグレーションを実行します。
    • 開発用: composer run-script --dev post-install-cmd
    • 実運用: composer run-script --no-dev post-install-cmd
  7. 「.apache.conf」ファイルを、wikiを設置する <VirstualHost> セクション内で Include します。
  8. Apacheを再起動します。
    sudo apachectl graceful

Algolia の Searchable Attributes (Rankingタブ) では、以下を設定しておきます。

  1. title
  2. tags
  3. summary
  4. recordTexts

更新 (実運用環境)

git fetch
git checkout $(git describe remotes/origin/master --tags)
composer install --no-dev

要件

依存するライブラリ由来の要件

Contribution

Pull Request、または Issue よりお願いいたします。

ライセンス

当スクリプトのライセンスは Mozilla Public License Version 2.0 (MPL-2.0) です。