https://github.com/remarkablemark/issue-formula

Σ Calculate mathematical formulas with issue data
https://github.com/remarkablemark/issue-formula

app dashboard forge forge-app formula gadget issues javascript jira jira-app jira-dashboard jira-gadget math react typescript

Last synced: 5 months ago
JSON representation

Σ Calculate mathematical formulas with issue data

• Host: GitHub
• URL: https://github.com/remarkablemark/issue-formula
• Owner: remarkablemark
• License: mit
• Created: 2024-03-05T01:07:58.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2025-04-10T04:16:56.000Z (about 1 year ago)
• Last Synced: 2025-04-11T05:16:15.526Z (about 1 year ago)
• Topics: app, dashboard, forge, forge-app, formula, gadget, issues, javascript, jira, jira-app, jira-dashboard, jira-gadget, math, react, typescript
• Language: TypeScript
• Homepage: https://marketplace.atlassian.com/1233729
• Size: 6.09 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          


  



# Issue Formula

[![release](https://img.shields.io/github/v/release/remarkablemark/issue-formula)](https://github.com/remarkablemark/issue-formula/releases)

[![build](https://github.com/remarkablemark/issue-formula/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablemark/issue-formula/actions/workflows/build.yml)

[![codecov](https://codecov.io/gh/remarkablemark/issue-formula/graph/badge.svg?token=GsBnfiZMCF)](https://codecov.io/gh/remarkablemark/issue-formula)

Issue Formula is a [Jira dashboard gadget](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-dashboard-gadget/) that calculates mathematical formulas with issue data.

[Get it now](https://marketplace.atlassian.com/apps/1233729/issue-formula). Read the [wiki](https://github.com/remarkablemark/issue-formula/wiki/).

[![Get it now](https://img.shields.io/badge/Get_it_now-f5cd47?style=for-the-badge&logo=atlassian&logoColor=0052cc)](https://marketplace.atlassian.com/apps/1233729/issue-formula)

## Prerequisites

[Set up Forge](https://developer.atlassian.com/platform/forge/set-up-forge/).

## Quick Start

Clone the repository:

```sh

git clone https://github.com/remarkablemark/issue-formula.git

cd issue-formula

```

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. View your changes with [Storybook](https://storybook.js.org/):

```sh

npm run storybook

```

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.

## License

[MIT](LICENSE)