compass-global-page-custom-ui

Compass globalPage template (Custom UI)

This project demonstrates the compass:globalPage module. It contains a Forge app written in Javascript that creates a global page in Compass called Hello world, then uses Custom UI to display Hello world! on the page.

Compass is currently in Beta. See atlassian.com/compass to request early access to Compass.

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

• Install dependencies inside of the static/global-page directory:

npm install

• Modify your app by editing the files in static/global-page/src/.

• Build your app (inside of the static/global-page directory):

npm run build

• Deploy your app by running:

forge deploy

• Install your app in an Atlassian site by running:

forge install

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.