goqoo

Goqoo on kintone

English | 日本語

Goqoo is a framework for kintone JavaScript/CSS customization. It works on Node.js.

Supports TypeScript transpiling, bundling with Babel/webpack, local preview with webpack DevServer, deployment using AWS S3, simple React/Vue.js templates, etc.

Requirements

• Node.js >= 14.5

Getting Started

$ npx goqoo new my-project
# Leave all prompt choices at their defaults and Enter
? Project name › my-project
? Project description › 
? Frontend Framework … 
❯ (None)
  React
  Vue

Goqoo creates my-project directory in the current directory, installs required libraries and files.

Moves to the new directory and make a git commit once.

$ cd my-project
$ git add .
$ git commit -m 'Initial commit'

$ npx goqoo generate app my-app

Goqoo creates my-app entry into the src/apps directory in the project, installs template files.

$ npx goqoo start

{ bundlerType: 'default', nodeEnv: 'development' }
{ mode: 'development' }
{ env: { WEBPACK_SERVE: true } }
{ 'my-app': 'https://localhost:59000/my-app.js' }

Goqoo builds JavaScripts files under src/apps directory, starts up local dev server and hosts the bundle file.

Set the URL of my-app displayed in the console as the JavaScript customization URL of your kintone app. If you see the alert "Hello, Goqoo on kintone!", the deployment is successful.

Commands

Create new project

$ goqoo new <project-name>

Creates new <project-name> directory in the current directory, sets the project name to <project-name> and installs required library and files. If <project-name> is omitted, the current directory is used as the project name.

Generate new app entry

# run in the project root directory
$ goqoo generate app <app-name>

Generates new <app-name> app entry and installs entry point file for JavaScript customization.

Generate new customize-view in exists app entry(when using React/Vue.js)

# run in the project root directory
$ goqoo generate customize-view <exists-app-name> <customize-view-name>

Generates new customize-view TS/CSS/HTML files in exists app entry src/apps/<exists-app-name>.

Generate kintone apps type definition files

$ goqoo generate dts

Create type definition files for kintone apps. Wrap @kintone/dts-gen to create type definition files for multiple apps at once.
You need to enumerate app ids in goqoo.config.js and set the kintone authentication information (password or API token) in .env.

Licence

MIT