{"id":20754486,"url":"https://github.com/atlassian-labs/compass-examples","last_synced_at":"2025-04-28T16:28:55.593Z","repository":{"id":66341260,"uuid":"581313208","full_name":"atlassian-labs/compass-examples","owner":"atlassian-labs","description":"Example apps and code snippets for Atlassian Compass","archived":false,"fork":false,"pushed_at":"2024-12-16T07:01:13.000Z","size":194,"stargazers_count":26,"open_issues_count":3,"forks_count":13,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-03-30T11:22:56.034Z","etag":null,"topics":["developer-experience","developer-experience-platform","developer-portal","devex","dx","examples","microservices","samples","service-catalog"],"latest_commit_sha":null,"homepage":"https://www.atlassian.com/software/compass","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atlassian-labs.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}},"created_at":"2022-12-22T20:56:10.000Z","updated_at":"2025-03-18T22:10:29.000Z","dependencies_parsed_at":"2024-06-04T01:00:58.412Z","dependency_job_id":"1192f77e-b445-448f-8f81-9c8f171530b5","html_url":"https://github.com/atlassian-labs/compass-examples","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/atlassian-labs%2Fcompass-examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlassian-labs%2Fcompass-examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlassian-labs%2Fcompass-examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlassian-labs%2Fcompass-examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atlassian-labs","download_url":"https://codeload.github.com/atlassian-labs/compass-examples/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251345264,"owners_count":21574679,"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":["developer-experience","developer-experience-platform","developer-portal","devex","dx","examples","microservices","samples","service-catalog"],"created_at":"2024-11-17T09:18:00.334Z","updated_at":"2025-04-28T16:28:55.577Z","avatar_url":"https://github.com/atlassian-labs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# compass-examples\n\n[![Atlassian license](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md)\n\n\u003e This repo is used for sharing example [Atlassian Forge apps](https://developer.atlassian.com/platform/forge/) \u0026 SDK code snippets, as well as code snippets for interacting with the [Atlassian Compass](https://www.atlassian.com/software/compass) API (GraphQL \u0026 REST). Compass was built from the ground up with extensibility in mind so you can build [the ultimate developer experience platform](https://www.youtube.com/watch?v=F92QM_3u0gw). Learn more about [building apps for Compass](https://developer.atlassian.com/cloud/compass/integrations/get-started-integrating-with-Compass/) using the Atlassian serverless app development platform Forge, our open-by-default [Compass APIs](https://developer.atlassian.com/cloud/compass/graphql/), and our [Compass Forge modules](https://developer.atlassian.com/platform/forge/manifest-reference/modules/index-compass/) that provide boilerplate to help you get started building faster.\n\n## Examples\n\n\u003e Details about each example found in this repo are below. Each directory contains a README with additional information/instructions about using each example.\n\n| Example | Description | \n| ------- | ----------- |\n| [dataProvider + events + metrics sample app](apps/sample-dataprovider-app-statuspage/) | A sample application that demonstrates how to use the [dataProvider module](https://developer.atlassian.com/platform/forge/manifest-reference/modules/compass-data-provider/) to create [event](https://developer.atlassian.com/cloud/compass/components/send-events-using-rest-api/) and [metric](https://developer.atlassian.com/cloud/compass/components/create-connect-and-view-component-metrics/) sources, then update events and metrics with a [webhook](https://developer.atlassian.com/platform/forge/manifest-reference/modules/web-trigger/). [Tutorial on creating a data provider app](https://developer.atlassian.com/cloud/compass/integrations/create-a-data-provider-app/).|\n| [GraphQL Snippets](snippets/graphql/) | A collection of various GraphQL queries and mutations that have been helpful for customers. |\n| [Forge GraphQL SDK Snippets](snippets/forge-graphql-sdk/) | A collection of various Forge GraphQL SDK usage examples. |\n| [GitLab app for Compass](https://github.com/atlassian-labs/gitlab-for-compass) | Not hosted in this repo but [the GitLab app for Compass is fully open source](https://github.com/atlassian-labs/gitlab-for-compass) and is a great \"production ready\" app to use as a reference.|\n\n## Handy links\n\n- [Get started integrating with Compass](https://developer.atlassian.com/cloud/compass/integrations/get-started-integrating-with-Compass/)\n- [Get a Compass site](https://www.atlassian.com/try/cloud/signup?bundle=compass) for development and testing\n- [Compass Forge modules](https://developer.atlassian.com/platform/forge/manifest-reference/modules/index-compass/)\n- [GraphQL API](https://developer.atlassian.com/cloud/compass/graphql/#overview)\n- [Compass Forge SDK](https://www.npmjs.com/package/@atlassian/forge-graphql)\n\n\n## Contributions\n\nContributions are welcome! We're open to improving upon any existing examples and accepting new examples from the community that may help other Compass users. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.\n\n## License\n\nCopyright (c) 2023 Atlassian US., Inc.\nApache 2.0 licensed, see [LICENSE](LICENSE) file.\n\n\u003cbr/\u003e\n\n[![With ❤️ from Atlassian](https://raw.githubusercontent.com/atlassian-internal/oss-assets/master/banner-cheers-light.png)](https://www.atlassian.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatlassian-labs%2Fcompass-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatlassian-labs%2Fcompass-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatlassian-labs%2Fcompass-examples/lists"}