Super Forge utilizies Vite.js a next generation frontend tool that utilizes hot module reloading to super charge your development experience. It has some built in patterns like type sharing and uses Vitest to provide hot reload unit testing already established.
To utilize Atlassian context while developing:
- Follow the steps to install Forge CLI
- Login to Forge using
forge login - Register the app with
forge register
npm icd static/super-forge-frontendnpm inpm run build- In a separate terminal:
forge deploy forge install -s <your-site>
forge tunnel- In a separate terminal:
npm run dev
Testing uses Forge Vitest as the test runner paired with Enzyme for the frontend. To run unit tests
npm run test
To run unit tests in the frontend
cd static/super-forge-frontendnpm run test
- Why does Forge keep asking me to approve access while running
forge tunnel?
If you change scope or permissions of your app (in the manifest.yml file), you will need to grant access in that same environment not in tunnel mode.
- Can I change what module this app type is?
Yes, the Confluence macro is just a default value to get developers started. Feel free to replace the module values with any of the existing Forge app modules.
- How can I contribute if i'm not the app owner?
Currently Forge is designed for single user development, which means they don't have a good story for adding contributors. To do it manually you will need to run forge register with a name like - and then revert the manifest.yml file before commiting your changes.