diff --git a/README.md b/README.md index 7e400b2..25da8af 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 +forge variables set --encrypt SUPABASE_API_KEY ``` -### 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 +forge variables set --environment production --encrypt SUPABASE_API_KEY +``` + +See [Environment variables](https://developer.atlassian.com/platform/forge/cli-reference/variables/) for more information. ## Support