# @netsells/nuxt-healthcheck

> Nuxt healthcheck module

Latest version **1.0.1** (published 2023-02-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @netsells/nuxt-healthcheck
pnpm add @netsells/nuxt-healthcheck
yarn add @netsells/nuxt-healthcheck
bun add @netsells/nuxt-healthcheck
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-02-16 |
| First published | 2023-02-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | rebeccaanderton, samturrell, spamoom, jakub.gawron |

## Links

- npm: https://www.npmjs.com/package/@netsells/nuxt-healthcheck
- npm.io page: https://npm.io/package/@netsells/nuxt-healthcheck

## Dependencies (1)

- [@nuxt/kit](https://npm.io/package/@nuxt/kit.md) ^3.2.0

## Recent versions

- 1.0.1 (latest) — 2023-02-16
- 0.0.0 — 2023-02-16

## README

# @netsells/nuxt-healthcheck

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]

> Nuxt module to provide a healthcheck path

## Features

Inspired by the nuxt 2 module by [fukuiretu](https://github.com/fukuiretu/nuxt-healthcheck), this module provides a `/healthcheck` url to respond to health check requests. 

## Quick Setup

1. Add `@netsells/nuxt-healthcheck` dependency to your project

```bash
# Using pnpm
pnpm add -D @netsells/nuxt-healthcheck

# Using yarn
yarn add --dev @netsells/nuxt-healthcheck

# Using npm
npm install --save-dev @netsells/nuxt-healthcheck
```

2. Add `@netsells/nuxt-healthcheck` to the `modules` section of `nuxt.config.ts`

```js
export default defineNuxtConfig({
  modules: [
    '@netsells/nuxt-healthcheck'
  ]
})
```

That's it! You can now use @netsells/nuxt-healthcheck in your Nuxt app ✨

## Development

```bash
# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release
```

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@netsells/nuxt-healthcheck/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@netsells/nuxt-healthcheck

[npm-downloads-src]: https://img.shields.io/npm/dm/@netsells/nuxt-healthcheck.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@netsells/nuxt-healthcheck

[license-src]: https://img.shields.io/npm/l/@netsells/nuxt-healthcheck.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@netsells/nuxt-healthcheck

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