概要
kintoneカスタマイズの開発環境を構築するための資料のまとめ。
チーム開発で新しく参加される方向け。
kintoneカスタマイズの情報は、cybozu developer networkを見れば良いが情報量が多いので迷わないように最低限の情報だけをまとめる。
対象
Webフロントエンドエンジニア
kintone触ったことない
kintoneカスタマイズ全く知らない
kintoneの開発環境の準備
前提条件
kintoneが導入済み
やること
- kintoneのアカウントの払い出し
- 作業用のkintoneスペースの作成
- 作業用のkintoneアプリの作成
説明
1. kintoneのアカウントの払い出し
管理者がアカウントを作成する
2. 作業用のkintoneスペースの作成
開発用として専用のスペースを作成する
スペースに1.で作成したアカウントを追加
3. 作業用のkintoneアプリの作成
開発用のkintoneアプリを作成
kintoneアプリに必要な権限を付与する。
kintoneカスタマイズの作業にはkintoneのアプリ管理権限の付与が必要。
kintoneカスタマイズ環境の準備
kintoneカスタマイズに関する参考資料のリンクと、カスタマイズのサンプルなどをまとめる。
コーディングガイドライン
kintoneカスタマイズ参考資料リンク
開発者ライセンス
APIを試す等に必要。
https://cybozudev.zendesk.com/hc/ja/articles/200720464
チュートリアル
まずチュートリアルをやってもらう。
カスタマイズサンプル
基本的にはチュートリアルで良い。後は現場で現状のカスタマイズされたソースコードを読んでもらう。
コーディング環境など
Gitの利用
必要に応じてGitを利用する
ライブラリ
適宜ライブラリを利用する
webpack
適宜webpack等を導入する
目指せ！JavaScriptカスタマイズ中級者（１） 〜webpack編〜
プラグイン開発
kintoneプラグインの基本的な情報とチュートリアルをまとめる。
kintoneプラグインの基本情報
プラグインとは何か、プラグイン化のメリットなど。
プラグイン開発環境
Node.jsをインストールしてwebpackを利用した開発環境を構築する
プラグインの開発は、下記の流れです。
- プラグイン作成に必要なファイルの準備します
- マニフェストファイル(manifest.json)の作成
- パッケージツール(plugin-packer)を利用してパッケージング
- 作成したプラグインファイルを kintone 環境にインストール
3.のplugin-packreを利用した初回のパッケージングの際に、PPKファイルが同時に作成されます。
2回目以降のパッケージングには初回に作成されたPPKファイルを指定してパッケージングすれば同じプラグインとして作成されます。
リリース版と別にプラグインをパッケージする際は、PPKを新規に生成することで別のプラグインとして生成可能です。
以下パッケージ手順より抜粋。
実行したディレクトリに、プラグインファイル (plugin.zip) と秘密鍵ファイル (ppkファイル) が生成されます。
秘密鍵ファイルのファイル名は、プラグインIDと同じです。
下記の例では、プラグインIDが「faabchdodajloackbgnipilddblmkejp」です。
秘密鍵ファイルは、2回目以降のパッケージングで利用するので、なくさないようご注意ください。
Web 版の plugin-packerもあります。
https://plugin-packer.kintone.dev/index-ja.html