{"id":29966300,"url":"https://github.com/aligent/gadget-bigcommerce-typescript-template","last_synced_at":"2025-08-04T02:32:44.201Z","repository":{"id":287991623,"uuid":"966450901","full_name":"aligent/gadget-bigcommerce-typescript-template","owner":"aligent","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-28T01:37:43.000Z","size":171,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-07-29T03:17:34.032Z","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-15T00:12:51.000Z","updated_at":"2025-05-15T01:12:46.000Z","dependencies_parsed_at":"2025-04-15T02:42:31.817Z","dependency_job_id":null,"html_url":"https://github.com/aligent/gadget-bigcommerce-typescript-template","commit_stats":null,"previous_names":["aligent/gadget-bigcommerce-typescript-template"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aligent/gadget-bigcommerce-typescript-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fgadget-bigcommerce-typescript-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fgadget-bigcommerce-typescript-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fgadget-bigcommerce-typescript-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fgadget-bigcommerce-typescript-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aligent","download_url":"https://codeload.github.com/aligent/gadget-bigcommerce-typescript-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aligent%2Fgadget-bigcommerce-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.941Z","updated_at":"2025-08-04T02:32:44.173Z","avatar_url":"https://github.com/aligent.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Aligent Gadget BigCommerce App Typescript Template\n\nThis repository was developed to help determine best practices and configuration for building BigCommerce apps with the [Gadget](https://gadget.dev/) platform.\n\n## Changes from the standard Gadget codebase\n\n- Aligent standard static analysis setup (tsconfig, eslint, prettier, editorconfig)\n  - Some deviations:\n    - tsconfig is declared inline as Gadget does not support `extends` configuration\n    - `no-unused-vars` rule loosened to make working with Gadget actions easier\n    - `no-console` added as Gadget provides a `logger` object\n    - `.gadget.ts` files are ignored because the Gadget server has a tendency to reformat them\n- `.yarn` added to `.ignore` and `.gitignore` (not strictly necessary as yarn classic doesn't create this folder)\n\n## Development\n\n### Philosophy\n\n- Develop locally in an IDE\n- Git repository is source of truth for code, not Gadget server\n  - Exceptions to the above are `.gadget.ts` files (schemas etc.), which are easier to work with in the Gadget editor\n- Sync code with a separate environment, and test in a separate app linked to that environment\n- When ready to promote to development, make a pull request\n\n### Quickstart\n\n#### Set up editing in your local IDE\n\n\u003e [!IMPORTANT]\n\u003e Gadget requires **Yarn Classic**. Corepack should detect this from the `packageManager` property in `package.json`\n\n- Open the Gadget Editor: `https://\u003cyour-app-name\u003e.gadget.app/edit/development`\n- Create a new development environment, cloning `development` ([Gadget documentation](https://docs.gadget.dev/guides/environments#adding-development-environments))\n- Clone this repository and sync local files with the server:\n\n```bash\ngit clone https://github.com/aligent/gadget-bigcommerce-typescript-template.git app-name\ncd ./app-name\nyarn gadget:link app-name environment-name\n```\n\n\u003e [!TIP]\n\u003e If prompted about conflicts, choose these options:\n\u003e\n\u003e - Merge local and environment's changes\n\u003e - Keep local conflicting changes\n\n\u003e [!CAUTION]\n\u003e Outright discarding files from the Gadget environment can leave it in an unusable state. If this happens you will need to push up a working app to the environment.\n\n#### Optional - fix linting errors\n\nrun `yarn lint --fix` in another terminal to identify (if possible) fix any linting errors in pulled down files\n\n#### Install your environment's version of the app in BigCommerce\n\n- Open `Settings \u003e Plugins \u003e BigCommerce` in the Gadget Editor with your environment selected\n- Follow the instructions under `Create a single-click BigCommerce app`, taking care to:\n  - Create a **new** app in the BigCommerce Developer Portal\n  - Fill in **all** the callback URLs (Make sure to click `Show all URLs` in Gadget)\n- Open `Apps \u003e My Apps \u003e My Draft Apps` in the BigCommerce Admin and install your app\n\n\u003e [!IMPORTANT]\n\u003e If multiple versions of an app are installed in one BigCommerce stores their processes may conflict. It's recommended to have different stores for testing each environment.\n\n#### Add features\n\n1. Create a feature branch from development\n2. Make code changes with `ggt dev` running, test in connected environment\n3. Commit changes to feature branch and PR back to `development`\n4. When PR is accepted, sync `development` branch and environment on Gadget:\n\n```bash\nnpx ggt push --env development\n```\n\n### Tips\n\nRead our gadget-specific [development notes](./docs/GADGET.md).\n\n### CI/CD\n\n**Local development**\n\n- `package.json` contains scripts for standard tasks - linting, testing, checking typescript compilation\n- Each of these is run as a pre-commit hook.\n- **Automated testing is currently stubbed**.\n\n**Source control**\n\n- A pipeline runs linting and testing on Pull Requests.\n- **Types are not checked** because they rely on type declarations in the `.gadget` folder which we do not commit to source control.\n\n## TODO\n\n- Work out how to protect `development` environment (or equivalent `staging` environment) so it is only modified by PR + pipeline\n- Set up automated testing\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fgadget-bigcommerce-typescript-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faligent%2Fgadget-bigcommerce-typescript-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faligent%2Fgadget-bigcommerce-typescript-template/lists"}