Forge repo instructions - 01-project-template-creation-solution

Forge
1

Project Template Creation

The Paw Registry tracks the pets coming in to the office which are represented as Jira work items. Fun facts about the dog will be automatically added that will come from a dog registry API resource.

In this exercise, we will begin by setting up the project template that will serve as the starting point for the remainder of the workshop.

Creating the project

  1. In your terminal or command line, go to the directory where you want to create the app

    • In your terminal, shell, or command prompt, call the forge command

      forge create

  2. Select or create a Developer Space for your app. If you do not have one yet, select Create a new Developer Space.

    ? Select or create a Developer Space: Create a new Developer Space

    Forge will create the app in your current directory. To learn more about Developer Spaces, go to Developer Spaces.

    • Enter a name for your Developer Space. The name can include dashes, spaces, and underscores.

      ? Enter a name for your Developer Space: T26 EU

  3. Enter the name for your app. Something descriptive will help you easily remember it.

    ? Enter a name for your app: Paw Registry

    Accept the agreement

    Please review the following agreement before continuing:

[ ] By continuing, I agree to the Atlassian Developer Terms and the Privacy Policy. If any Forge app added to this Developer Space exceeds the free usage allowance, I agree to be billed for any excess usage based on the then-current price.

    - Developer Terms: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
    - Privacy Policy: https://www.atlassian.com/legal/privacy-policy
- Pricing: https://developer.atlassian.com/platform/forge/forge-platform-pricing/

? Do you accept? (y/N) y

  4. Choose a suitable template for the app you’re trying to build. For this exercise, we’ll use Jira’s issue context template

    ? Select an Atlassian app or platform tool: Jira
? Select a category: UI Kit
? Select a template: jira-issue-panel

  5. Verify if the app has been successfully created. Open your favorite IDE or text editor and load the newly created project. You should be able to see the following files and directories:

    Paw-Registry
├── AGENTS.md
├── manifest.yml
├── node_modules
├── package-lock.json
├── package.json
├── README.md
└── src
    ├── frontend
    │    └── index.jsx
    ├── resolvers
    │    └── index.js
    └── index.js

  6. Without doing any changes, let’s deploy the app to the default environment (development)

    • Go to your project directory by typing the following command

      cd Paw-Registry

    • Run the Forge deployment command

      forge deploy

  7. Install the app

    • Run the command

      forge install

    • Select the context

      ? Select an Atlassian app or platform tool: Jira

    • Enter your site / cloud instance URL

      ? Enter the site URL: my-site.atlassian.net

    • Accept the prompt to continue with the installation

      ? Do you want to continue? Y
? Are you sure you want to proceed? Y

Verifying if the app is installed

  1. Go to your Jira instance.

  2. Open a work item, if you do not have one, create a new one.

  3. Since this is the first time you are opening the issue panel app, click the button below the summary to enable the app. The issue panel app should appear above the Activity panel once the button is clicked.

Forge repo instructions - index