Skip to content

atlassian/atlassian-connect-example-app-java

Repository files navigation

[WIP] atlassian-connect-sample-app-java

NOTE: This repository is in progress and is not ready yet.

About

This repository contains a Spring Boot starter for building an Atlassian Connect app. This app is aimed to help you to easily add your integration in Jira.

Table of Contents

Features

  • TBD

Getting started

  • TBD

Running your application

  • You can run this app in 3 simple steps:
    • Install dependencies - Run mvn clean install.

    • Tunneling - For this purpose, we are using ngrok. You need to set the ngrok authtoken in the env file, so please make sure you have a ngrok account. Simply go to ngrok and copy your authtoken and paste it in the .env file.

    • Running docker compose - Then simply run docker-compose up. Once the docker finishes running, you can view the tunneled URL in the logs. img.png

After you have the tunneled URL, check for the config in the url /atlassian-connect.json(https://TUNNELED_URL/atlassian-connect.json). This is the app descriptor URL for uploading the app and installing in Jira.

Testing

  • TBD

Getting help

  • TBD

License

The project is available as open source under the terms of the MIT License.