Forge Hello World

See developer.atlassian.com/platform/forge/ for documentation and tutorials explaining Forge.

Requirements

See Set up Forge for instructions to get set up.

Quick start

• Modify your app frontend by editing the src/frontend/index.jsx file.

• Modify your app backend by editing the src/resolvers/index.js file to define resolver functions. See Forge resolvers for documentation on resolver functions.

In summary, you can run this command to deploy and install the app in the first terminal:

forge lint --fix -e development
forge deploy -e development
forge install -e development -s gitauto.atlassian.net --upgrade --confirm-scopes --non-interactive
forge tunnel -e development

• See more about forge lint
• See more about forge deploy
• See more about forge install
• See more about forge tunnel

And run this command in the second terminal to see the logs in forge cloud. See Forge logs for more information.

forge logs -e development
# or
forge logs -e development --grouped

• Use the forge deploy command when you want to persist code changes.
• Use the 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.

Environment Variables

For development, you can do the following:

forge variables list -e development
forge variables set --environment development --encrypt SUPABASE_URL <value>
forge variables set --environment development --encrypt SUPABASE_API_KEY <value>

For production, you have to do the following:

forge variables list -e production
forge variables set --environment production --encrypt SUPABASE_URL <value>
forge variables set --environment production --encrypt SUPABASE_API_KEY <value>

See Environment variables for more information.

Support

See Get help for how to get help and provide feedback.