Skip to content

Home

Jump to bottom
hakumai22 edited this page Apr 13, 2025 · 14 revisions

Office-Addin-Project wikiへようこそ！

目次

概要

このプロジェクトは漢文アドインを作るプロジェクトです。

開発方法

github codespacesまたはローカルの開発環境を使用します。

codespacesの使いすぎに注意してください。月９０時間までしか使用できません。

codespacesやローカルでの使い方、実行方法についてはセットアップで紹介します。

セットアップ

セットアップ方法には以下の二つがあります。

codespacesで開発

  1. まずリポジトリのメイン画面に戻る。
  2. 緑色のCodeボタンからCodespacesタブに変えてdevelopを押す。
  3. 完了。

実行方法

  1. kanbun-addinディレクトリに移動する
    cd kanbun-addin
  2. ビルドする
    npm run build
  3. zip化する
    zip -r dist.zip dist/
    →zipファイルを右クリックしてダウンロード
  4. デプロイする
    こちらを開く。
    public_html/www.hakumai22.shopディレクトリを開きアップロード→zipファイルを選択後、左上のチェックマークを押す。そしたら閉じて大丈夫です。
  5. 任意のプラットフォームのOfficeを開く。
    アドイン→その他のアドイン→左上の個人用アドイン→右上のマイアドインのアップロードというところをクリックする。
    参照をクリックし、先ほどダウンロードされたzipファイルからdist→manifest.xmlを選択して、アップロードを押す。
    アドインの名前があるタブ(デフォルトはShow task pane)をクリックしたら完了！！

ローカルで開発

  1. githubデスクトップやgitなどの任意の方法でクローンする
  2. vscodeでクローンしたディレクトリを開く。
  3. 完了。

実行方法

  1. kanbun-addinディレクトリに移動する
    cd kanbun-addin
  2. サーバーを起動する
    npm run dev-server
  3. 任意のプラットフォームのOfficeを開く。
    アドイン→その他のアドイン→左上の個人用アドイン→右上のマイアドインのアップロードというところをクリックする。
    参照をクリックし、プロジェクトディレクトリ→dist→manifest.xmlを選択して、アップロードを押す。
    アドインの名前のタブ(デフォルトはShow task pane)をクリックしたら完了！！

ブランチについて

主な開発ブランチはdevelopにする予定です。 コンフリクトを防ぐためにdevelopブランチには直接コミットしないことを推奨します。 main→developへのマージは安定的に動作するかつ完成度が高くなってきた場合、以下の条件を満たした場合マージされます。

  • 厳密なコードレビューが行われている
  • 本番環境でのバグチェックが行われているかつ安定的に動作する
  • 同意を得ている

以下の場合は直接mainにコミットしても大丈夫です。逆にdevelopには出さないでほしいです。（プルリクを出してくれたら１日のうちには対応します）

  • .github/workflows/〇〇.yml
  • Readme.md

ブランチ構成を図に示すと、

main
└── develop
    └── some branches(bug_fix,ui_design,code_prepare,update_futureなど)

という感じです。 ブランチの説明はこちら

Clone this wiki locally