{"id":23380606,"url":"https://github.com/agility/agility-cms-app-sdk","last_synced_at":"2026-02-13T05:03:13.383Z","repository":{"id":45377501,"uuid":"421083907","full_name":"agility/agility-cms-app-sdk","owner":"agility","description":"The SDK for building marketplace and private apps for extending the Agility Content Manager UI.","archived":false,"fork":false,"pushed_at":"2024-11-19T22:29:11.000Z","size":281,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-09-06T19:55:41.896Z","etag":null,"topics":["agility","apps","cms","javascript","react"],"latest_commit_sha":null,"homepage":"https://github.com/agility/agility-cms-app-sdk","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/agility.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2021-10-25T15:38:33.000Z","updated_at":"2024-11-19T22:29:09.000Z","dependencies_parsed_at":"2024-11-19T22:34:54.597Z","dependency_job_id":null,"html_url":"https://github.com/agility/agility-cms-app-sdk","commit_stats":{"total_commits":40,"total_committers":2,"mean_commits":20.0,"dds":"0.025000000000000022","last_synced_commit":"a08e81ea6169902602c6b869d289aa0b322ec1e2"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/agility/agility-cms-app-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagility-cms-app-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagility-cms-app-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagility-cms-app-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagility-cms-app-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agility","download_url":"https://codeload.github.com/agility/agility-cms-app-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agility%2Fagility-cms-app-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29396847,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T04:26:15.637Z","status":"ssl_error","status_checked_at":"2026-02-13T04:16:29.732Z","response_time":78,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["agility","apps","cms","javascript","react"],"created_at":"2024-12-21T20:17:02.147Z","updated_at":"2026-02-13T05:03:13.369Z","avatar_url":"https://github.com/agility.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Agility CMS App SDK\n\nThis is a React SDK for building UI Apps for Agility CMS.\n\n## Local Development\n\nIf you want to develop this SDK locally and test it in another project, follow these steps:\n\n### Step 1: Clone and Install Dependencies\n\nFirst, clone the repository and install dependencies.\n\n```bash\ngit clone https://github.com/agility/agility-cms-app-sdk.git\ncd agility-cms-app-sdk\nyarn install\n```\n\n### Step 2: Build the SDK\n\nBefore using the SDK in your local project, build the package using the following command:\n\n```bash\nyarn build\n```\n\nThis will clean, compile, and bundle the SDK, placing the output in the `dist` folder.\n\n### Step 3: Link the SDK for Local Development\n\nTo use the SDK in your local project, you can use yarn link. This allows your local project to reference the SDK directly without needing to publish it to npm.\n\n```bash\ncd agility-cms-app-sdk\nyarn link\n```\n\n### Step 4: Using the SDK in Your Project\n\nOnce the SDK is linked, you can link it to your project:\n\n```bash\ncd your-project\nyarn link \"@agility/app-sdk\"\n```\n\nAt this point, your project will use the local version of the SDK.\n\n### Step 5: Watching for Changes\n\nIf you're actively developing the SDK, you can start the watch mode for continuous builds:\n\n```bash\ncd agility-cms-app-sdk\nyarn watch\n```\n\nThis will watch for changes and rebuild the SDK as needed.\n\n## Avoiding React Linking:\n\nTo avoid conflicts between React versions, React is treated as a peer dependency and is not bundled with the SDK. This ensures that your project provides the React version, and you don't need to manually link React.\n\nYou may run into issues trying link to apps that are using Next.JS. If you can an error like that you can try to add the following to your `next.config.js`:\n\n```js\nwebpack: (config) =\u003e {\n\t\tconfig.resolve.alias = {\n\t\t\t...config.resolve.alias,\n\t\t\treact: path.resolve(__dirname, \"node_modules/react\"),\n\t\t\t\"react-dom\": path.resolve(__dirname, \"node_modules/react-dom\")\n\t\t}\n\t\treturn config\n\t},\n```\n\n### Notes On Peer Dependencies\n\n- Peer Dependencies: The SDK expects your project to provide its own version of react and react-dom that meets the version requirements specified in the SDK’s peerDependencies.\n- Shared React: As long as your project provides a compatible React version, everything will work without requiring manual linking.\n\nThis setup prevents version conflicts, avoids the need for linking React manually, and ensures that your project and the SDK share the same React instance.\n\n### Unlinking the SDK\n\nTo unlink the SDK from your project, run the following command:\n\nIn your project:\n\n```bash\ncd your-project\nyarn unlink \"@agility/app-sdk\"\n```\n\nIn the SDK:\n\n```bash\ncd agility-cms-app-sdk\nyarn unlink\n```\n\nThis will restore the original packages from npm in both your SDK and the project.\n\n## Example Apps\n\nOne of the best ways to learn a new SDK is to see some examples! Check out these sample apps to help you get started:\n\n### [Google Analytics](https://github.com/agility/agility-cms-app-google-analytics)\n\nA dashboard app that uses OAuth to connect to Google and pull Google Analytics data.\n\n### [Google Translate](https://github.com/agility/agility-cms-app-google-translate)\n\nA sidebar app that translates and detects language for the current content item.\n\n### [BigCommerce](https://github.com/agility/agility-cms-app-bigcommerce)\n\nA custom field app that allows selection of a product from BigCommerce. It includes a modal with a product listing and search component.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagility%2Fagility-cms-app-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagility%2Fagility-cms-app-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagility%2Fagility-cms-app-sdk/lists"}