Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remarkablemark/jira-dashboard-gadget
⚙️ Jira dashboard gadget Forge app
https://github.com/remarkablemark/jira-dashboard-gadget
app atlassian atlassian-jira dashboard forge forge-app gadget javascript jira jira-app jira-dashboard jira-gadget react typescript
Last synced: 7 days ago
JSON representation
⚙️ Jira dashboard gadget Forge app
- Host: GitHub
- URL: https://github.com/remarkablemark/jira-dashboard-gadget
- Owner: remarkablemark
- License: mit
- Created: 2024-03-04T04:07:25.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-10-29T13:17:37.000Z (about 2 months ago)
- Last Synced: 2024-10-29T16:00:37.177Z (about 2 months ago)
- Topics: app, atlassian, atlassian-jira, dashboard, forge, forge-app, gadget, javascript, jira, jira-app, jira-dashboard, jira-gadget, react, typescript
- Language: TypeScript
- Homepage:
- Size: 4.02 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jira Dashboard Gadget
[](https://github.com/remarkablemark/jira-dashboard-gadget/actions/workflows/build.yml)
This project contains a Forge app written in JavaScript that displays `Hello World!` in a [Jira dashboard gadget](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-dashboard-gadget/).
See [documentation and tutorials](https://developer.atlassian.com/platform/forge) explaining Forge.
## Prerequisites
[Create a Forge app](https://developer.atlassian.com/platform/forge/set-up-forge/) and replace `app.id` in [manifest.yml](manifest.yml).
## Quick Start
Clone the repository:
```sh
git clone https://github.com/remarkablemark/jira-dashboard-gadget.git
cd jira-dashboard-gadget
```
Install the dependecies:
```sh
npm install
```
Log in to your Atlassian account:
```sh
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](https://developer.atlassian.com/platform/forge/runtime-reference/custom-ui-resolver/) for documentation on resolver functions.
Build, deploy, and install your app in an Atlassian site:
```sh
npm run deploy
```
Develop your app by running `forge tunnel` to proxy invocations locally:
```sh
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
- [Manage your apps](https://developer.atlassian.com/platform/forge/manage-your-apps/)
- [Product bridge APIs](https://developer.atlassian.com/platform/forge/apis-reference/ui-api-bridge/bridge/)
- [Atlassian design system](https://atlassian.design/components)
## Examples
- [Issue Formula](https://github.com/remarkablemark/issue-formula)
## License
[MIT](LICENSE)