# @oasisdigital/atlassian-connect-nx-plugin

> To install ngrok (which we use as a tunnel for Atlassian Connect to see your localhost app) run one of the following commands:

Latest version **0.1.6** (published 2024-02-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @oasisdigital/atlassian-connect-nx-plugin
pnpm add @oasisdigital/atlassian-connect-nx-plugin
yarn add @oasisdigital/atlassian-connect-nx-plugin
bun add @oasisdigital/atlassian-connect-nx-plugin
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.6 |
| Published | 2024-02-05 |
| First published | 2023-09-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 35.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Zachary Kipping |
| Maintainers | zjkipping, dpsthree |
| Keywords | atlassian, connect, atlassian-connect, tooling, nx, plugin |

## Links

- npm: https://www.npmjs.com/package/@oasisdigital/atlassian-connect-nx-plugin
- Repository: https://github.com/OasisDigital/atlassian-tooling
- Homepage: https://github.com/OasisDigital/atlassian-tooling/blob/main/libs/atlassian-connect-nx-plugin/README.md
- Issues: https://github.com/OasisDigital/atlassian-tooling/issues
- npm.io page: https://npm.io/package/@oasisdigital/atlassian-connect-nx-plugin

## Dependencies (7)

- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [ngrok](https://npm.io/package/ngrok.md) ^5.0.0-beta.2
- [tslib](https://npm.io/package/tslib.md) ^2.3.0
- [dotenv](https://npm.io/package/dotenv.md) 16.3.1
- [@nx/devkit](https://npm.io/package/@nx/devkit.md) ^16.8.1
- [@nx/angular](https://npm.io/package/@nx/angular.md) ^16.8.1
- [@nx/express](https://npm.io/package/@nx/express.md) ^16.8.1

## Recent versions

- 0.1.6 (latest) — 2024-02-05
- 0.1.5 — 2023-09-15
- 0.1.4 — 2023-09-08
- 0.1.3 — 2023-09-08
- 0.1.2 — 2023-09-08
- 0.1.1 — 2023-09-08
- 0.1.0 — 2023-09-08
- 0.0.8 — 2023-09-08
- 0.0.7 — 2023-09-08
- 0.0.6 — 2023-09-08
- 0.0.5 — 2023-09-08
- 0.0.4 — 2023-09-08
- 0.0.3 — 2023-09-08
- 0.0.2 — 2023-09-08
- 0.0.1 — 2023-09-08

## README

# Atlassian Connect Nx Plugin

## Prerequisites

### Ngrok

To install ngrok (which we use as a tunnel for Atlassian Connect to see your localhost app) run one of the following commands:

`npm install -g ngrok`

`yarn global add ngrok`

[Once you have installed `ngrok` globally on your device, follow "Step 3" from the `ngrok` documentation to authenticate ngrok for your device.](https://ngrok.com/docs/getting-started/#step-3-connect-your-agent-to-your-ngrok-account)

> In the future we will try to incorporate this authentication into this package to avoid globally installing `ngrok`.

## Installation

Run one of the following commands in a Nx workspace:

`npm install --save-dev @oasisdigital/atlassian-connect-nx-plugin`

`yarn add --dev @oasisdigital/atlassian-connect-nx-plugin`

## Generating Your Atlassian Connect Application

1. Run the following command to create your own Angular + Express applications to run on Atlassian Connect:  
   `npx nx generate @oasisdigital/atlassian-connect-nx-plugin:app`

2. Once you have generated your application you will need to fill out our Atlassian environment configuration. You can do this by copying the `.env.atlassian-connect.template` that was generated in your Angular application and renaming it to `.env.atlassian-connect`. Make sure to fill out the env variables in this file to match your Atlassian configuration!

## Serving Your Application

Run the following command to serve your Angular + Express applications:

`npx nx connect-serve {angular-app-name}`

Replacing the `{angular-app-name}` with the name of your generated Angular application.

> This also includes a `ngrok` tunnel for your convenience.

## Building Your Application

Run the following command to build your Angular + Express applications:

`npx nx connect-build {angular-app-name}`

Replacing the `{angular-app-name}` with the name of your generated Angular application.

> The built files will be under the `dist` directory of your Express application's name.

---
_Source: https://npm.io/package/@oasisdigital/atlassian-connect-nx-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._