Last updatedJan 2, 2020

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

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: macro, function
  • Forge UI:
    • Button, Form, Fragment, Text, TextArea, TextField components.
    • useProductContext, useState hooks.
  • Other:
    • Calls the Jira REST API with asApp to create issues.
    • Creates Atlassian Document Format (ADF).

QR code app

Displays a QR code in a Confluence page.

Details

  • Code: QR code repository
  • Products: Confluence
  • Modules: macro, function
  • Forge UI:
    • Fragment, Image, Form, TextField, Select, Option components.
    • useContentProperty hook.
  • 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: macro, function
  • Forge UI:
    • Button, Fragment, Text, Table, Head, Row, Cell, Form, TextField components.
    • useProductContext, useState, useContentProperty hooks.
  • Other:
    • Shows a configuration view before displaying the result.
    • Uses Confluence content properties to store data.
    • Calls Jira REST API with asUser to get information about the user.

World time app

Displays timezone information on a Confluence page.

Details

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