NOTE: This repository is in progress and is not ready yet.
This repository contains a Flask starter for building an Atlassian Connect app. This app is aimed to help you to easily add your integration in Jira.
- TBD
To run the Python sample app you'll need to have to following installed:
- Python 3
- Docker
Once the pre-reqs have been met you simply need to:
- create a .env file and add your
NGROK_AUTHTOKEN
. Create/log into your ngrok account and simply copy your token from the home page (found under 'Connect your account'). - run
docker-compose up
. Once the docker finishes running, you can view the tunneledNGROK_URL
in the logs.
Now that the sample up is up-and-running, you just need to navigate to your Jira instance (you can create one here if you don't already have one) and:
- navigate to Apps in the navbar > Manage your apps
- click Settings, check the box next to Enable development mode and click Apply
- refresh the page
- click Upload app, paste in
<NGROK_URL>/atlassian-connect.json
, and click Upload
- TBD
- TBD
- TBD
The project is available as open source under the terms of the MIT License.