# Sprint Optimizer

Developed as part of Senior Project Spring 2020 - Team 28

Developers: William Elias, Matt Taylor

## Development

### Requirements:

* Node.js (v4.5.0 or later) and npm
* ngrok (install through `npm install --save-dev ngrok`)
* node-pre-gyp (install through  `npm install node-pre-gyp -g` )
* atlas-connect (install through `npm install -g atlas-connect`)
    * Verify installation by running `atlas-connect -V`
* sqlite3 (install through `npm install sqlite3`)

### Creating `credentials.json`

* Log into and create an API key at https://id.atlassian.com/manage/api-tokens
* Create a file called `credentials.json` in the root project directory, using `credentials-sample.json` as a base
    * This file is used during development to connect to and deploy your local instance of the add-on to your development server. **It is NOT needed for production, and should not be committed to the repository (keep it in .gitignore)**
* Fill the password field with your API key and the username field with your account email address

For more info, use the **Getting started with Jira Cloud development** guide, located [here.](https://developer.atlassian.com/cloud/jira/platform/getting-started/)

### Installing dependencies

* Once cloned, make sure to install all dependencies by running `npm install` at the project root
* Then, the project can be run using `npm start`, assuming a valid `credentials.json` file has been created

## Atlassian Connect docs

[Read the docs](https://bitbucket.org/atlassian/atlassian-connect-express/src/master/README.md).

## Tutorial Videos and other Demonstrations

- Azure DevOps Automation using Pipelines: https://youtu.be/-NhL25wkgBg

- Environment Setup Video: https://youtu.be/l484W8x2nUo

- Deploying to your Jira Instance: https://youtu.be/xl6ByBUu3bA