https://github.com/volrog/forge-app-template
Quickstart template for Atlassian Forge apps: ready-made template using Yarn Berry (PnP), TypeScript, React, Vite, Vitest & Playwright
https://github.com/volrog/forge-app-template
atlassian eslint forge playwright react reactjs template typescript vite vitest yarn yarn-berry yarn-pnp yarn-workspaces
Last synced: 6 months ago
JSON representation
Quickstart template for Atlassian Forge apps: ready-made template using Yarn Berry (PnP), TypeScript, React, Vite, Vitest & Playwright
- Host: GitHub
- URL: https://github.com/volrog/forge-app-template
- Owner: volrog
- License: mit
- Created: 2025-06-16T11:20:19.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-12-22T10:31:14.000Z (7 months ago)
- Last Synced: 2025-12-23T21:47:30.587Z (7 months ago)
- Topics: atlassian, eslint, forge, playwright, react, reactjs, template, typescript, vite, vitest, yarn, yarn-berry, yarn-pnp, yarn-workspaces
- Language: TypeScript
- Homepage:
- Size: 146 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Forge App Template
## Getting Started
All instructions assume that you are using macOS or Debian-based Linux on your host machine.
### Environment setup
- Install [nvm][nvm-docs]
- Run `nvm use` from project root to install required node.js version
- Run `corepack enable` to install required version of package manager (yarn)
- Install [@forge/cli][forge-cli-docs]
### Prepare development instance
- Create new cloud dev instance http://go.atlassian.com/cloud-dev
- Enable development mode on your cloud instance yourinstance.atlassian.net/plugins/servlet/upm (for jira) or yourinstance.atlassian.net/wiki/plugins/servlet/upm (for confluence)
## Development
### First start
1. Install dependencies
```bash
yarn install
```
2. Open `packages/forge-jira` and [log in with an Atlassian API token][forge-getting-started].
```bash
cd packages/forge-jira && forge login
```
3. Register your app
```bash
yarn forge:register # from anywhere places in the project
```
or
```bash
forge register # from packages/forge-jira
```
4. Build frontend and deploy your app
```bash
yarn forge:deploy # from anywhere places in the project
```
5. Install your app to your dev instance
```bash
yarn forge:install # from anywhere places in the project
```
### Manual development
1. After the first installation (see First Start) you can build frontend and deploy changes manually
```bash
yarn forge:deploy
```
2. After major changes to the `manifest.yml`, deploy and upgrade the app:
```bash
yarn forge:upgrade # from anywhere places in the project
```
### Start dev server
1. After the first installation (see First Start) you can start a Forge tunnel to redirect requests to localhost (vite dev server):
```bash
yarn start # from root of project
```
2. After major changes to the `manifest.yml`, deploy and upgrade the app:
```bash
yarn forge:upgrade # from anywhere places in the project
```
## Project structure
```
.
├── packages/
│ ├── forge-jira/
│ │ ├── src/
│ │ ├── manifest.yml
│ │ ├── package.json
│ │ └── ...
│ ├── frontend/
│ │ ├── src/
│ │ ├── index.html
│ │ ├── package.json
│ │ └── ...
│ └── shared/
│ ├── src/
│ ├── package.json
│ └── ...
├── tsconfig.json
├── package.json
└── yarn.lock
```
## License
This project is licensed under the [MIT License](./LICENSE).
[forge-cli-docs]: https://developer.atlassian.com/platform/forge/cli-reference/
[nvm-docs]: https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating
[forge-getting-started]: https://developer.atlassian.com/platform/forge/getting-started/#log-in-with-an-atlassian-api-token