# nuxt-deploy-notifier

> [![Latest Version on NPM](https://img.shields.io/npm/v/nuxt-deploy-notifier.svg?style=flat-square)](https://npmjs.com/package/nuxt-deploy-notifier) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

Latest version **0.0.3** (published 2021-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install nuxt-deploy-notifier
pnpm add nuxt-deploy-notifier
yarn add nuxt-deploy-notifier
bun add nuxt-deploy-notifier
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2021-07-05 |
| First published | 2021-07-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Chantouch Sek |
| Maintainers | chantouchsek |
| Keywords | notification, nuxt-build, nuxt notification build, noxt build nofititication, nuxt build notifier |

## Links

- npm: https://www.npmjs.com/package/nuxt-deploy-notifier
- Repository: https://github.com/chantouchsek/nuxt-build-notifier
- npm.io page: https://npm.io/package/nuxt-deploy-notifier

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [consola](https://npm.io/package/consola.md) ^2.15.3
- [chalk-table](https://npm.io/package/chalk-table.md) ^1.0.2

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2021-07-05
- 0.0.2 — 2021-07-03
- 0.0.1 — 2021-07-03

## README

# Nuxt Build Notifier

[![Latest Version on NPM](https://img.shields.io/npm/v/nuxt-deploy-notifier.svg?style=flat-square)](https://npmjs.com/package/nuxt-deploy-notifier)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
[![npm](https://img.shields.io/npm/dt/nuxt-deploy-notifier.svg?style=flat-square)](https://npmjs.com/package/nuxt-deploy-notifier)
[![npm](https://img.shields.io/npm/dm/nuxt-deploy-notifier.svg?style=flat-square)](https://npmjs.com/package/nuxt-deploy-notifier)

This module provides a simple Slack notification of your deployment after success.

## Installation

```sh
yarn add nuxt-deploy-notifier
```

## Usage

Simply add the module to your nuxt config:

```js
export default {
    buildModules: [
        'nuxt-deploy-notifier',
    ],
}
```

And define any applicable options:

```js
export default {
    deployNotifiers: {
        appName: null, // required
        slackChannel: null, // required
        slackWebhookUrl: null, // required
    },
}
```

## Options

The following options are available:

### `APP_URL`

- Type: `string`
- Required: `true`
- Description: `Set this from .env file`

### `appName`

- Type: `string`
- Required: `true`
- Description: `The application name`

### `slackWebhookUrl`

- Type: `string`
- Required: `true`

### `slackChannel`

- Type: `string`
- Required: `true`

The webhook url to send the Slack notification to your channel of choice. For information on how to setup a webhook, check out the [Slack Documentation](https://api.slack.com/messaging/webhooks). If no value is supplied, no notification will be sent.

# Contact

Email: chantouchsek.cs83@gmail.com

Twitter [@DevidCs83](https://twitter.com/DevidCs83)

## License

This package is under the [MIT License](LICENSE).

---
_Source: https://npm.io/package/nuxt-deploy-notifier · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._