create-looker-extension

Create Looker Extensions with zero manual configuration

This utility helps you rapidly create new Looker Extension Framework applications.

We recommend this utility as a quick way to start nearly all extension projects. The output is intended to be a foundation that you can customize and build upon, without having to worry about any of the under-the-hood configuration.

Example usage:

You must have Yarn installed to use this tool.

yarn create looker-extension <your-project-name>
cd <your-project-name>
yarn develop

Developing this template

To run this project locally (for testing changes, etc.), use the following command from the root folder.

yarn new <your-project-name>

The template must be generated to a folder that doesn't exist, so a typical flow to incrementally test the template creation would be:

yarn new testfoo
# answer prompts
cd testfoo
# look at the generated project, yarn develop, etc.
cd ..
rm -rf testfoo

Deploying this project

Releases are handled by this workflow which uses a wombat dressing room and a "release backed token". In order for it to publish correctly you must create a new GitHub Release and use very specific release name and tag name format. Use this release as a template:

• release name: @looker/create-looker-extension create-looker-extension-vX.Y.Z
• tag name (choose create new tag or separately create it beforehand): create-looker-extension-vX.Y.Z

Supported languages & frameworks

Currently, create-looker-extension can bootstrap extensions with:

• React & Javascript
• React & Typescript
• "Vanilla" (plain) Javascript
• "Vanilla" (plain) Typescript

We recommend you use React for the best development experience, but you're welcome to use plain vanilla Javascript or any framework of your choice. Please feel free to submit a PR for supporting your favorite framework!

More about the Extension Framework

The Looker extension framework is a development framework that significantly reduces the effort and complexity of building custom JavaScript data applications and tools for Looker. Custom applications and tools created with the extension framework can be accessed from within Looker, allowing Looker to handle functions such as authentication, API access, and access control and permission management.

• See example extensions here
• Extension framework documentation