This repo is used for sharing example Atlassian Forge apps & SDK code snippets, as well as code snippets for interacting with the Atlassian Compass API (GraphQL & REST). Compass was built from the ground up with extensibility in mind so you can build the ultimate developer experience platform. Learn more about building apps for Compass using the Atlassian serverless app development platform Forge, our open-by-default Compass APIs, and our Compass Forge modules that provide boilerplate to help you get started building faster.
Details about each example found in this repo are below. Each directory contains a README with additional information/instructions about using each example.
| Example | Description |
|---|---|
| dataProvider + events + metrics sample app | A sample application that demonstrates how to use the dataProvider module to create event and metric sources, then update events and metrics with a webhook. Tutorial on creating a data provider app. |
| GraphQL Snippets | A collection of various GraphQL queries and mutations that have been helpful for customers. |
| Forge GraphQL SDK Snippets | A collection of various Forge GraphQL SDK usage examples. |
| GitLab app for Compass | Not hosted in this repo but the GitLab app for Compass is fully open source and is a great "production ready" app to use as a reference. |
- Get started integrating with Compass
- Get a Compass site for development and testing
- Compass Forge modules
- GraphQL API
- Compass Forge SDK
Contributions 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 for details.
Copyright (c) 2023 Atlassian US., Inc. Apache 2.0 licensed, see LICENSE file.
