Skip to content

Commit 1f98809

Browse files
Merge pull request #21 from gitautoai/wes
Update README.md
2 parents 0156f3d + 11e36fb commit 1f98809

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

README.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Forge Hello World
22

3-
This project contains a Forge app written in Javascript that displays `Hello World!` in a Jira issue panel.
4-
53
See [developer.atlassian.com/platform/forge/](https://developer.atlassian.com/platform/forge) for documentation and tutorials explaining Forge.
64

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

1513
- 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.
1614

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

1917
```shell
2018
forge lint --fix
2119
forge deploy
20+
forge install -e development -s gitauto.atlassian.net --upgrade --confirm-scopes --non-interactive
21+
forge tunnel
2222
```
2323

24-
- Install your app in an Atlassian site by running:
24+
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.
2525

2626
```shell
27-
forge install --upgrade
27+
forge logs -e development
28+
# or
29+
forge logs -e development --grouped
2830
```
2931

30-
- Develop your app by running `forge tunnel` to proxy invocations locally:
32+
- Use the `forge deploy` command when you want to persist code changes.
33+
- Use the `forge install` command when you want to install the app on a new site.
34+
- 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.
35+
36+
## Environment Variables
37+
38+
For development, you can do the following:
3139

3240
```shell
33-
forge tunnel
41+
forge variables list -e development
42+
forge variables set --encrypt SUPABASE_URL <value>
43+
forge variables set --encrypt SUPABASE_API_KEY <value>
3444
```
3545

36-
### Notes
46+
For production, you have to do the following:
3747

38-
- Use the `forge deploy` command when you want to persist code changes.
39-
- Use the `forge install` command when you want to install the app on a new site.
40-
- 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.
48+
```shell
49+
forge variables list -e production
50+
forge variables set --environment production --encrypt SUPABASE_URL <value>
51+
forge variables set --environment production --encrypt SUPABASE_API_KEY <value>
52+
```
53+
54+
See [Environment variables](https://developer.atlassian.com/platform/forge/cli-reference/variables/) for more information.
4155

4256
## Support
4357

0 commit comments

Comments
 (0)