Nuxt Maintenizr

Maintenance module for Nuxt.js

• Release Notes
• Documentation

Features

• Nuxt 3 ready
• Typescript support
• Override default maintenance page
• CLI to manage maintenance status of application

Quick Setup

1. Add nuxt-maintenizr dependency to your project:

npx nuxi module add nuxt-maintenizr

2. Add nuxt-maintenizr to the modules section of nuxt.config.ts:

export default defineNuxtConfig({
  modules: ['nuxt-maintenizr'],
});

That's it! You can now use a beautiful and modern maintenance mode in your Nuxt app ✨

How to use

1. Show current status of the application:

npx nuxt-maintenizr status 

2. Enable maintenance mode (Turn off the application):

npx nuxt-maintenizr down

3. Disable maintenance mode (Turn on the application):

npx nuxt-maintenizr up

Contribution

Local 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

Support

Hi, I am Thomerson Roncally, a Fullstack Developer that love to build things to help other developers. If you like my work and want to support me, you can donate here: