This step describes creating, changing, and installing a simple app. The focus is on learning the CLI commands needed to work with an app.
Complete Step 1: Set up Forge before working through this page.
Create an app based on the Hello world template. Note, the CLI uses keychain to securely store your login details. If you see a prompt for keychain access when running a command, approve it to allow the CLI to run the command.
The hello-world template uses Node.js and has the following structure:
1 2 3 4 5 6 7
hello-world-app |-- src | `-- index.jsx |-- manifest.yml |-- package.json |-- package-lock.json `-- README.md
Let’s have a look at what these files are:
When creating your app, we also create three environments for you: development, staging, and production. Environments are where you deploy your app. Once an app is running in an environment, you can install it from that environment on to an Atlassian site.
We recommend using the development environment for testing your changes, staging for a stable version of your app, and production as the version of your app that’s ready for use. For the rest of this tutorial you’ll only use the development environment.
By default, the CLI will run commands for the development environment unless you specify another with the flag.
This app displays content within a Confluence page using a . Confluence shows the title of the macro in the quick insert menu when you add the app to a page. Let's change the title to include your name.
Your file should look like the following, with your values for the title and app ID.
1 2 3 4 5 6 7 8 9 10 11 12
modules: macro: - key: hello-world function: main title: Forge app for <your name> description: Inserts Hello world! function: - key: main handler: index.run app: id: '<your app id>' name: hello-world-app
Deploy your app, with the command, any time you make changes to the code. This command builds your code and reports any compilation errors.
Install your app, with the command, when you want to install your app on a new site. Note, once the app is installed on a site, the site picks up the new app changes you deploy without needing to run the install command again.
Install your app by running:
With your app installed, it’s time to see the app on a page.
/Forge app for
Publish the page.
Your Hello world app is now installed into your development site. The app should display on the page like the image below.
See Step 3: Call a product API to learn how to call a product API from your app.