Example apps

Example apps are a great way to see what you can build with Forge. Explore the apps listed below to learn how Atlassian develops Forge apps.

Usage

We recommend you clone the app to have a local version to explore and customize. You'll need the Forge CLI to install the example apps, see set up Forge for guidance on getting set up.

To use an app:

1. Click through to the code repository.
2. Clone the repository.
3. Open your command line, and navigate to the example app code.
4. Register a new copy of the app to your account by running:

   1

   forge register

5. Install the app's dependencies by running:

   1

   npm install

6. Deploy the app by running:

   1

   forge deploy

7. Install the app by running:

   1

   forge install

DACI helper app

Adds a Confluence macro that inspects the page and identifies missing, inconsistent, or incorrect information based on the DACI Confluence template.

Details

• Code: DACI helper repository
• Products: Confluence
• Modules: function and macro
• Forge UI:
  • Fragment, Image, and Text components.
  • useAction and useProductContext hooks.

• Other:

  • Implements a parser to read Atlassian Document Format (ADF) from a Confluence page.
  • Uses an SVG and the Image component to render results.

Dictionary app

Displays the definition of the selected text in an inline dialog. If the definition doesn't exist, the user can submit a new one.

Details

• Code: Dictionary repository
• Products: Confluence
• Modules: confluence:contextMenu, function
• Forge UI:
  • InlineDialog, ContextMenu, Text, Form, TextArea components.
  • useProductContext, useState, useAction hooks.
• Other:
  • Uses Confluence content properties to store data.
  • Uses the Confluence REST API to read content properties from a page.

Feedback collector app

Adds a form to collect feedback on a Confluence page. When a user submits feedback, a Jira issue is created with the details.

Details

• Code: Feedback collector repository
• Products: Confluence, Jira
• Modules: function and macro
• Forge UI:
  • Button, Form, Fragment, Text, TextArea, and TextField components.
  • useProductContext and useState hooks.
• Other:
  • Calls the Jira REST API with asApp to create issues.
  • Creates Atlassian Document Format (ADF).

Issue alerting app

Adds a Jira issue panel that displays SignalFx alert details, alert charts, and links to view the alert in SignalFx.

Details

• Code: Issue alerting repository
• Products: Jira
• Modules: function, jira:issuePanel, and webtrigger
• Forge UI:
  • Button, ButtonSet, Image, and Text components.
  • useProductContext and useState hooks.
• Other:
  • Uses a web trigger to link SignalFx detectors to Jira issues.
  • Uses Forge environment variables and Jira entity properties to store SignalFx alert data by project.

Issue countries app

Adds an issue panel that displays a world map, where the highlighted countries are related to the current issue that’s selected via a custom field.

Details

• Code: Forge issue countries repository
• Products: Jira
• Modules: function and jira:issuePanel
• Forge UI:
  • Button, Fragment, Image, and Text components.
  • useProductContext, useAction, and useState hooks.
• Other:
  • Calls the Jira REST API with asUser to get issue details and custom fields.

Issue health app

Adds a Jira issue glance that displays the health of the issue. The app determines the issue health from the number of issues blocked, number of days without updates, and how many sprints have contained the issue.

Details

• Code: Issue health repository
• Products: Jira
• Modules: function and jira:issueGlance
• Forge UI:
  • Button, Fragment, and Text components.
  • useProductContext and useState hooks.
• Other:
  • Calls the Jira REST API with asUser to get issue details.

Issue translator app

Adds a Jira issue panel that translates the contents of an issue into a range of different languages using the Azure Translator Text API.

Details

• Code: Issue translator repository
• Products: Jira
• Modules: function and jira:issuePanel
• Forge UI:
  • Button, ButtonSet, Fragment, and Text components.
  • useProductContext and useState hooks.
• Other:
  • Translates the Jira summary and description fields using Azure Translator Text API
  • Uses secure environment variables for Azure API authentication tokens.

Open pull requests validator app

Adds a Jira workflow validator that checks Bitbucket Cloud for open pull requests before an issue transitions.

Details

• Code: Open pull requests validator repository
• Products: Bitbucket, Jira
• Modules: function, jira:workflowValidator, and webtrigger
• Other:
  • Calls the Bitbucket Cloud API to retrieve pull requests.
  • Uses environment variables to access configuration and secret values.

QR code app

Displays a QR code in a Confluence page.

Details

• Code: QR code repository
• Products: Confluence
• Modules: function and macro
• Forge UI:
  • Form, Fragment, Image, Option, Select, and TextField components.
  • useConfig and useContentProperty hooks.
• Other:
  • Uses Confluence content properties to store data.

Simple sign-up app

Adds a sign-up form to a Confluence page.

Details

• Code: Simple sign-up repository
• Products: Confluence, Jira
• Modules: function and macro
• Forge UI:
  • Button, Cell, Form, Fragment, Head, Row, Table, Text, and TextField components.
  • useContentProperty, useProductContext, and useState hooks.
• Other:
  • Shows a configuration view before displaying the result.
  • Uses Confluence content properties to store data.
  • Calls the Jira REST API with asUser to get information about the user.

Slack events app

Posts message to a Slack channel in response to Atlassian product events. For example, when an issue is created or someone comments on a page.

Details

• Code: Slack events repository
• Products: Confluence, Jira
• Modules: function and trigger
• Other:
  • Responds to product events in Jira and Confluence.
  • Uses the Slack API to post messages.

Slack unfurls app

Automatically displays issue previews in Slack using message link unfurling when a users posts a Jira issue link.

Details

• Code: Slack unfurls repository
• Products: Jira
• Modules: function and webtrigger
• Other:
  • Receives and posts Slack event webhooks.
  • Asynchronously waits for responses when calling the Jira REST API.

User limits app

Adds a Jira workflow validator that checks for the number of issues assigned to a user before an issue transitions.

Details

• Code: User limits repository
• Products: Jira
• Modules: function and jira:workflowValidator
• Other:
  • Calls the Jira REST API with asApp to get issue details.
  • Uses Forge environment variables to set the maximum number of issues a user can have in the target status.

Wheel of fortune app

Displays a wheel on a Confluence page that spins to make a random choice. You set the options for the wheel using a table on the page.

Details

• Code: Wheel of fortune repository
• Products: Confluence
• Modules: macro and function
• Forge UI:
  • Fragment, Image, Option, Select, Text, and TextField components.
  • useAction, useContentProperty, and useState hooks.
• Other:
  • Uses the Confluence API to read values from a page.
  • Generates an SVG for animation.

World time app

Displays timezone information on a Confluence page.

Details

• Code: World time repository
• Products: Confluence
• Modules: macro and function
• Forge UI:
  • Form, Fragment, Option, Select, Text, and TextField components.
  • useContentProperty and useState hooks.
• Other:
  • Contains two macros.
  • Uses Confluence content properties to store data.
  • Shows a configuration view before displaying the result.