Skip to content

Update README.md #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 25 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Forge Hello World

This project contains a Forge app written in Javascript that displays `Hello World!` in a Jira issue panel.

See [developer.atlassian.com/platform/forge/](https://developer.atlassian.com/platform/forge) for documentation and tutorials explaining Forge.

## Requirements
Expand All @@ -14,30 +12,46 @@ See [Set up Forge](https://developer.atlassian.com/platform/forge/set-up-forge/)

- Modify your app backend by editing the `src/resolvers/index.js` file to define resolver functions. See [Forge resolvers](https://developer.atlassian.com/platform/forge/runtime-reference/custom-ui-resolver/) for documentation on resolver functions.

- Build and deploy your app by running:
In summary, you can run this command to deploy and install the app in the first terminal:

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

- Install your app in an Atlassian site by running:
And run this command in the second terminal to see the logs in forge cloud. See [Forge logs](https://developer.atlassian.com/platform/forge/cli-reference/logs/) for more information.

```shell
forge install --upgrade
forge logs -e development
# or
forge logs -e development --grouped
```

- Develop your app by running `forge tunnel` to proxy invocations locally:
- 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:

```shell
forge tunnel
forge variables list -e development
forge variables set --encrypt SUPABASE_URL <value>
forge variables set --encrypt SUPABASE_API_KEY <value>
```

### Notes
For production, you have to do the following:

- 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.
```shell
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](https://developer.atlassian.com/platform/forge/cli-reference/variables/) for more information.

## Support

Expand Down
Loading