Skip to content

QuickStart.md

Latest commit

 

History

History
59 lines (43 loc) · 1.63 KB

QuickStart.md

File metadata and controls

59 lines (43 loc) · 1.63 KB

QuickStart

This guide is the minimum you need to do to get your Phoenix Custom App published. You may find this useful as a "cheat sheet", after completing and understanding the concepts taught in the README guide.

Clone the StarterKit

Clone and install the with-data branch of the StarterKit

git clone https://github.com/DomoApps/StarterKit.git
cd StarterKit
git checkout with-data
npm install

Init

Choose manifest only when running the domo init command:

domo init

Edit your manifest

Refer to the Dev Studio Manifest page if needed.

  • Open manifest.json
  • Change the height and width
  • Add a column alias for columns you plan to query that have spaces or long names
  • Save the file

Login and publish

Login to the correct Domo instance and publish your App. This will allow you to connect to your dataset locally when running npm start.

domo login
npm run deploy

Startup

Startup the webpack server

npm start

Develop

Open src/index.js and change the lines indicated with Step # to use your dataset

  1. Set datasetAlias to use the same name in your manifest
  2. Set the column "name" and "type" to columns in your dataset
  3. Set a chart type using the correct enum
  4. Set your Chart Options

Publish

Once you have your App looking the way you want it locally you will need to publish your current version to your instance.

npm run deploy