Nuxt Maintenance Mode

Overview

This module for Nuxt.js allows for the display of a maintenance view while the application is in maintenance mode. It renders the specified routing content for maintenance and returns a status code of 503 to the client. This module ensures that the application remains in maintenance state without compromising SEO or the user’s access experience.

Features

• Maintenance Mode: Activates maintenance mode on startup for the Nuxt application.
• Fallback Content Routing: Specifies the routing content to be displayed during maintenance mode.
• Path Matcher: Allows for specifying a path regex to be in maintenance mode.

Installation

To install this module, you need to follow these steps:

1. Install the package from NPM:

   npm install nuxt-maintenance-mode
   

2. Add 'nuxt-maintenance-mode' to the modules property in the nuxt.config.js file:

   modules: [
     'nuxt-maintenance-mode'
   ]
   

3. Add maintenance mode options to the nuxt.config.js file:

   maintenance: {
     enabled: true, // Activate maintenance mode on startup
     path: '/maintenance', // Specify maintenance fallback content routing
     matcher: '/maintenance' // Specify a path regex to be in maintenance mode
   }
   

Please note that this project is under development and welcomes aggressive pull requests for improvement.

Summary

The Nuxt.js maintenance mode module provides an easy and effective way to put an application in a maintenance state without affecting SEO or the user’s access experience. By rendering specified routing content for maintenance, it ensures that the application remains functional and responsive during maintenance periods. The installation process is straightforward, and the module offers various options for customization. Overall, this module is a useful addition for developers working with Nuxt.js.