{"id":21590986,"url":"https://github.com/toolsplus/forge-turbo","last_synced_at":"2025-03-18T10:15:32.103Z","repository":{"id":117347998,"uuid":"457689538","full_name":"toolsplus/forge-turbo","owner":"toolsplus","description":"Forge app with Custom UI, based on a monorepo structure using Turborepo","archived":false,"fork":false,"pushed_at":"2022-02-10T09:23:50.000Z","size":303,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-24T16:28:38.833Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/toolsplus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-10T08:18:31.000Z","updated_at":"2023-02-20T11:01:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"4eec4d61-86a9-4caf-8456-a2d81fabb7bf","html_url":"https://github.com/toolsplus/forge-turbo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolsplus%2Fforge-turbo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolsplus%2Fforge-turbo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolsplus%2Fforge-turbo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toolsplus%2Fforge-turbo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toolsplus","download_url":"https://codeload.github.com/toolsplus/forge-turbo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244198406,"owners_count":20414443,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T16:21:36.010Z","updated_at":"2025-03-18T10:15:32.083Z","avatar_url":"https://github.com/toolsplus.png","language":"TypeScript","readme":"# Forge Monorepo Example\n\nSimple example of a Forge app with Custom UI, based on a monorepo structure using [Turborepo](https://turborepo.org/).\n\n## Goals\n\n* Simple build and dev workflow\n* Allows extracting shared logic to separate packages\n* Easily use shared logic in Forge backend (FAAS) and custom UI frontend\n\n## Getting started\n\nMake sure you have the required dependencies to develop Forge apps installed. See [Getting started](https://developer.atlassian.com/platform/forge/getting-started/) for instructions.\n\nAfter that, run `npm install` from the project root. This will install dependencies for the root project and all sub-projects (custom UIs and Forge app).\n\nRegister the Forge app by running the following command from the `apps/forge` folder \n\n    forge register\n\nBuild the app from the project root directory by running\n\n    npm run build\n\nThis will build shared dependencies (`packages`), custom UI project and finally deploy the Forge app.\n\nFinally, install the app, again by running the command from the `apps/forge` folder\n\n    forge install\n\n## Usage\n\n### Development\n\n\u003e The development process does not work yet as expected (see Known Issues below).\n\n    npm run dev\n\nTo work around this issue do the following:\n\n1. Remove the `dev` script from `apps/forge/package.json`\n2. Run `npm run dev` from the project root\n3. Run `forge tunnel` from `apps/forge` directory\n\n### Build\n\nSimply run the following command from the project root:\n\n    npm run build\n\n## Known issues\n\n### Development workflow does not work as expected\n \nRunning `turbo run dev` (or `npm run dev`) from the project root does not work as expected. Forge tunnel complains `the input device is not a TTY` which seems to have to do with the [Docker process startup](https://stackoverflow.com/questions/43099116/error-the-input-device-is-not-a-tty). \n\nAdditionally, the Forge linter produces the errors, but they are not fatal. Linting errors seem to be an issue with relative paths in the `manifest.yml`:\n\n```\n=== Running forge lint...\n\n/app/manifest.yml\n23:10   error    missing index.html file in directory (../issue-panel/build) is being referenced by a custom UI resource in jira:issuePanel module  valid-resource-required\n\n23:10   error    missing directory '../issue-panel/build' is being referenced by 'issue-panel-resource' in resources  valid-resource-required\n\n27:10   error    missing index.html file in directory (../issue-glance/build) is being referenced by a custom UI resource in jira:issueGlance module  valid-resource-required\n\n27:10   error    missing directory '../issue-glance/build' is being referenced by 'issue-glance-resource' in resources  valid-resource-required\n\n```\n\n### Running specific Forge CLI commands\n\nTo run specific Forge CLI commands (`forge register`, `forge install`, etc.), you should run them directly from the `apps/forge` directory. However, it should not be too difficult to tweak Turborepo to allow running them from the project root as well.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoolsplus%2Fforge-turbo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoolsplus%2Fforge-turbo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoolsplus%2Fforge-turbo/lists"}