{"id":29966299,"url":"https://github.com/aligent/appbuilder-typescript-template","last_synced_at":"2025-08-04T02:32:44.241Z","repository":{"id":287990846,"uuid":"965818648","full_name":"aligent/appbuilder-typescript-template","owner":"aligent","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-23T07:17:31.000Z","size":768,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-07-29T03:17:31.821Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aligent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-14T00:38:30.000Z","updated_at":"2025-06-17T16:30:18.000Z","dependencies_parsed_at":"2025-04-15T02:29:43.355Z","dependency_job_id":"f5836dbd-9a63-491f-bda3-935eec08ad1e","html_url":"https://github.com/aligent/appbuilder-typescript-template","commit_stats":null,"previous_names":["aligent/appbuilder-typescript-template"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aligent/appbuilder-typescript-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fappbuilder-typescript-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fappbuilder-typescript-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fappbuilder-typescript-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fappbuilder-typescript-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aligent","download_url":"https://codeload.github.com/aligent/appbuilder-typescript-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fappbuilder-typescript-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268639931,"owners_count":24282678,"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","status":"online","status_checked_at":"2025-08-04T02:00:09.867Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-08-04T02:32:19.918Z","updated_at":"2025-08-04T02:32:44.190Z","avatar_url":"https://github.com/aligent.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Aligent Typescript Template for Adobe AppBuilder\n\nThis repository contains a ready-to-build application including two actions and a simple frontend.\nFrontend and action code is fully typed, actions are bundled with sourcemaps using `ts-loader` for step-through debugging.\n\n# Setup\n\n## Prerequisites\n\n- Access to the [Adobe Developer Console](https://developer.adobe.com/developer-console/)\n- Access to an existing AppBuilder project\n- Up-to-date global installation of the [Adobe aio CLI](https://developer.adobe.com/runtime/docs/guides/tools/cli_install/)\n\n## Set up the repository\n\n```bash\nnpm ci # Install dependencies\naio app use # Select the desired workspace - this will build your .aio and .env files\n```\n\nAdd the BASE_URL environment variable required for the api-sample action to your `.env` file\n\n```bash\nBASE_URL=https://pokeapi.co/api/v2/pokemon/\n```\n\n## Development\n\nUse the `aio cli` for development commands. A comprehensive list of commands and options can be found on github : https://github.com/adobe/aio-cli\n\n### Serving the app locally\n\n- `aio app dev` will serve **both** actions and frontend locally\n- `aio app run` will **deploy** actions to the AppBuilder platform and serve the frontend locally\n- The local server is exposed on `localhost:9080` by default\n\n### Debugging in VS Code\n\nOpen the VSCode Debugging Panel (`CTRL-Shift-D`) and run either of the pre-defined AppBuilder launch schemas.\n\nAlternatively, create a new Javascript Debug Terminal and run `aio app dev`/`aio app run` as needed.\n\nBreakpoints in typescript code are supported with inline source maps.\n\n### Test \u0026 Coverage\n\n- Run `aio app test` to run the testing suite\n- Run `npm run check-types` to check all typescript types\n\n### Deploy \u0026 Cleanup\n\n- `aio app deploy` to build and deploy all actions on Runtime and static files to CDN\n- `aio app undeploy` to undeploy the app\n\n## Config\n\n### `app.config.yaml`\n\n- Main configuration file that defines an application's implementation.\n- Variables in `.env` can be referenced with a `$` prefix e.g. `$SERVICE_API_KEY`\n- Documentation: https://developer.adobe.com/app-builder/docs/guides/configuration/#appconfigyaml\n\n```yaml\napplication:\n  hooks:\n    pre-app-build: ./hooks/check-action-types.sh \u0026\u0026 ./hooks/check-web-types.sh\n  actions: actions\n  web: web-src\n  runtimeManifest:\n    packages:\n      appbuilder:\n        license: Apache-2.0\n```\n\n### `.env`\n\n\u003e [!CAUTION]\n\u003e\n\u003e - Do not commit to source control\n\n- Generated with `aio app use`\n- Makes secrets and environment variables available at build time\n- Documentation: https://developer.adobe.com/app-builder/docs/guides/configuration/#env\n\n```bash\n# AIO_RUNTIME_AUTH=\n# AIO_RUNTIME_NAMESPACE=\n\n# BASE_URL\n```\n\n### `.aio`\n\n\u003e [!CAUTION]\n\u003e\n\u003e - Do not edit manually\n\u003e - Do not commit to source control\n\n- Generated with `aio app use` or the `Download All` button in an Adobe Developer Console workspace\n- Configuration for Developer Console\n- Documentation: https://developer.adobe.com/app-builder/docs/guides/configuration/#aio\n\n### `*webpack-config.js`\n\n- Used by `aio cli` for bundling typescript code\n- Adds inline source maps to support runtime debugging breakpoints in Typescript files\n\n## General pain points in this repository\n\nThis setup is brittle and confusing in a few areas. Some of that is because of the aio CLI's opinionated behaviour, some may be because the Typescript and package settings aren't quite right.\n\n- `aio app test` (jest) and `aio app build` (webpack for actions) require a babel setup for typescript support\n- Parcel will detect a standard `babel.config.js` file and warn about it\n- Babel and parcel do not typecheck, so hooks are used to check types before building actions/web folders\n- AppBuilder doesn't support ESM syntax for `*webpack-config.js`, so the whole package has to be commonjs. For consistency only the standard aligent config files (prettier, eslint) are kept as `.mjs`\n- Jest doesn't understand the transpiled `.js` imports, requiring `moduleNameMapper` configuration in `jest.config.js`\n- `babel-jest` hoists mock declarations to the top of the files which can make it very tricky to mock nested functions from `@adobe/aio-sdk`; the `jest` import is not available at the time mocks are initialised\n\n## Under development\n\n- [ ] Deployment pipeline\n- [ ] Pre-commit hooks\n- [x] Front End calling deployed actions\n- [ ] Front End extension point example\n- [x] Cleaner tsconfig setup separating tests, actions, web code\n- [x] Use Babel instead of ts-loader for action compiling\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fappbuilder-typescript-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faligent%2Fappbuilder-typescript-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fappbuilder-typescript-template/lists"}