Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.19 KB

README.md

File metadata and controls

49 lines (34 loc) · 2.19 KB
Raw

Compass component details example app (UI Kit)

This project demonstrates the compass:componentPage, compass:adminPage, and compass:teamPage modules for Forge. It contains a Forge app written in Javascript that creates a new subtab called Hello world on the Compass component details and team details pages, then uses UI Kit to display Hello world! on the subtabs. It also displays a table that contains data of the Compass component retreived using the GraphQL API Toolkit.

Compass is currently in Beta. Visit go.atlassian.com/get-compass to get started.

See developer.atlassian.com/platform/forge/ for documentation and tutorials explaining Forge.

Requirements

See Set up Forge for instructions to get set up.

Quick start

  • Install top-level dependencies:
npm install

  • Modify your app by editing the src/component-page.jsx or src/admin-page.jsx file.

  • Register your app by running:

forge register
  • Build and deploy your app by running:
forge deploy
  • Install your app in an Atlassian site by running:
forge install
  • Develop your app by running forge tunnel to proxy invocations locally:
forge tunnel

Notes

  • Use the forge deploy command when you want to persist code changes.
  • Use the forge install command when you want to install the app on a new site.
  • Once the app is installed on a site, the site picks up the new app changes you deploy without needing to rerun the install command.

Support

See Get help for how to get help and provide feedback.