axolotl

Our modest contribution to Atlassian Codegeist 2021.

AXOLOTL - Atlassian Forge app

The src folder contains the source code of the AXOLOTL Forge app which is based upon the Forge Example "Forge QR Code" and licensed under the Apache License, Version 2.0.

Please refer to the original repository at https://bitbucket.org/atlassian/forge-qr-code/ for details.

The AXOLOTL project was submitted to Codegeist 2021 less than 2 hours before the deadline - please see https://devpost.com/software/axolotl

Prerequisites

• Node.js v12.x or later

• Forge CLI:

  npm i -g @forge/cli

  If the command fails, please check the @forge/cli NPM page for installation details

Installing the app

Check that forge is installed correctly:

forge --version

You should see 2.0.1

Before deploying your app you need to create an API key on your atlassian space: Atlassian API Token Click on Create API token.

After the creation, copy the created code and then run from command line:

forge login

Follow the steps displayed and insert the API Token when requested.

You can then register the app and choose a name for it

forge register

Next, it is necessary to install the dependencies

npm install

Deploy the app on the development environment

forge deploy

And finally install it on your site

forge install

You will be asked to select the product (in this case Confluence) and the site where to install the app (e.g. username.atlassian.net)

If everything went as expected, you should find the app on your confluence site.

Usage

You can test the AXOLOTL app by creating an empty document in Confluence and inserting app /qrcode

⚠️ When you add the app in your Confluence page you won't find it with the name specified after the forge register command. Instead, look for the title in manifest.yml. In this case the app is called "Axolotl QR Code"

About Atlassian Codegeist 2021

Highlights from the Codegeist 2021 Home Page:

Make your move to win — build Forge apps for Jira and Confluence — $300,000 in prizes.

• What to build: Build innovative cloud apps using Atlassian’s Forge platform in one of the following categories:
  • Apps for DevOps Teams
  • Apps for IT
  • Apps for Business.
• Submissions Due: September 13 at 5:00PM ET

More details:

• Register to Codegeist 2021
• Official Rules
• Devpost Terms of Service

Codegeist 2021 Resources

https://codegeist.devpost.com/resources

Get Set Up

• Atlassian Cloud Developer License
• Getting Started documentation

Technical Resources

• Platform Concepts documentation
• Forge Tutorials

Get Help

• Join the Atlassian Developer Community - Use #Codegeist to make sure your technical questions are viewable to everyone participating

Inspiration

• DevOps apps in the marketplace
• IT apps in the marketplace
• Business apps in the marketplace
• Codegeist's blog post

This is just a small collection to get you started!

App Marketplace

• Marketplace Overview
• Listing Forge Apps
• Distributing Apps

Not required for the hackathon

More about Atlassian Forge

• https://developer.atlassian.com/platform/forge/#atlassian-example-apps
  • https://developer.atlassian.com/platform/forge/getting-started/
  • https://developer.atlassian.com/platform/forge/example-apps/
  • https://developer.atlassian.com/platform/forge/build-a-hello-world-app-in-confluence/
  • https://developer.atlassian.com/platform/forge/build-a-hello-world-app-in-jira/
• Forge examples: https://bitbucket.org/atlassian/workspace/projects/FE
• Atlassian Delivers on Forge App Dev Platform Promise - DevOps.com, 2021-05-27