Skip to content

remarkablemark/jira-dashboard-gadget

Repository files navigation

Jira Dashboard Gadget

This project contains a Forge app written in JavaScript that displays Hello World! in a Jira dashboard gadget.

See documentation and tutorials explaining Forge.

Prerequisites

Create a Forge app and replace app.id in manifest.yml.

Quick Start

Clone the repository:

git clone https://github.com/remarkablemark/jira-dashboard-gadget.git
cd jira-dashboard-gadget

Install the dependecies:

npm install

Log in to your Atlassian account:

npm run login

Modify the frontend app by editing the src/frontend/src/index.tsx file.

Modify the backend app by editing the src/backend/index.js file to define resolver functions. See Forge resolvers for documentation on resolver functions.

Build, deploy, and install your app in an Atlassian site:

npm run deploy

Develop your app by running forge tunnel to proxy invocations locally:

npx forge tunnel

Notes

  • Use the npx forge deploy command when you want to persist code changes.
  • Use the npx 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.

Resources

License

MIT