@netsells/nuxt-healthcheck

@netsells/nuxt-healthcheck

Nuxt module to provide a healthcheck path

Features

Inspired by the nuxt 2 module by fukuiretu, this module provides a /healthcheck url to respond to health check requests.

Quick Setup

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

# 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

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

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

Development

# 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