ochi51 / kintone-plugin-template

kintone plugin template

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

kintone plugin template

概要

サイボウズの kintone Plugin開発のテンプレート.

インストール

Nodeのインストール

Node.jsをインストールしておく必要がある.

Mac

  brew install node

brewを使っていない場合は, これ とかを参考にインストールしてください.

nodebrewを使ってバージョン管理を行いたい場合は, こことかを参考に してください.

Windows

WindowsでNode.jsを利用する場合, nodistが便 利ですこれ とかを参考にインストールしてください. インストール後は, 以下のコマンドでnodeのバージョンをv0.12.0にしてください.

  nodist + v0.12.0
  nodist v0.12.0

※Windowsの場合, node-sassのインストールでエラーが起きる場合があります. node-sassを先にインストールしてからnpm installすると解決する場合があります.

依存ライブラリのインストール

依存ライブラリは npm を用いて管理されている.

  npm install

以上で依存ライブラリがインストールされる.

主な利用ライブラリ

主に以下のライブラリを利用している.

使い方

初期設定

新規開発の場合は, 1度ビルドする必要がある

  npm run build

以下のconfigファイルを編集する必要がある.

    src/print-creator/config.coffee

pluginKeyに, 生成されたppkファイルのパスを指定する.

既存プラグインの場合は, ppkファイルをプロジェクト配下に置き, そのパスを指定する

JavaScriptやSASSのビルド

Gulp タスクが幾つか用意されている.

ビルド

ビルドするためには

  npm run build

を実行する. これを実行する前に npm install を行って依存ライブラリが正しくインストールして おく必要がある.

ビルド元ファイルは src 以下にある. ビルド後のファイルは基本的に web 以下に出力される.

Watch

開発時に, ファイルの変更を検知して, ビルド + ライブリロードなどといったことを自動的に行ってく れるタスクが用意されている.

監視プロセスを立ち上げるためには以下のコマンドを実行する.

  npm run watch

ライセンス

MIT

About

kintone plugin template

License:MIT License


Languages

Language:CSS 94.1%Language:JavaScript 3.1%Language:Shell 1.6%Language:CoffeeScript 0.7%Language:HTML 0.5%