{"id":13810548,"url":"https://github.com/potato4d/nuxt-maintenance-mode","last_synced_at":"2025-04-04T12:07:29.794Z","repository":{"id":35174747,"uuid":"167695035","full_name":"potato4d/nuxt-maintenance-mode","owner":"potato4d","description":"Maintenance mode module for Nuxt.js.","archived":false,"fork":false,"pushed_at":"2024-10-29T21:43:05.000Z","size":1940,"stargazers_count":107,"open_issues_count":19,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-30T01:37:36.713Z","etag":null,"topics":["maintenance-mode","nuxt","nuxt-module","typescript","vue"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/potato4d.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-26T14:00:59.000Z","updated_at":"2024-10-29T21:42:50.000Z","dependencies_parsed_at":"2023-12-25T21:24:27.837Z","dependency_job_id":"751f30d6-0b98-4e21-93e2-95c2bb825583","html_url":"https://github.com/potato4d/nuxt-maintenance-mode","commit_stats":{"total_commits":480,"total_committers":7,"mean_commits":68.57142857142857,"dds":"0.38749999999999996","last_synced_commit":"e1976dc625a35569c05823b449ce8ffdea31134b"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/potato4d%2Fnuxt-maintenance-mode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/potato4d%2Fnuxt-maintenance-mode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/potato4d%2Fnuxt-maintenance-mode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/potato4d%2Fnuxt-maintenance-mode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/potato4d","download_url":"https://codeload.github.com/potato4d/nuxt-maintenance-mode/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247174418,"owners_count":20896078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["maintenance-mode","nuxt","nuxt-module","typescript","vue"],"created_at":"2024-08-04T02:00:59.365Z","updated_at":"2025-04-04T12:07:29.778Z","avatar_url":"https://github.com/potato4d.png","language":"TypeScript","funding_links":["https://patreon.com/potato4d"],"categories":["TypeScript"],"sub_categories":[],"readme":"**This package is no longer maintained.**\n\n# Maintenance mode module for Nuxt.js\n\n[![codecov](https://codecov.io/gh/potato4d/nuxt-maintenance-mode/branch/master/graph/badge.svg)](https://codecov.io/gh/potato4d/nuxt-maintenance-mode)\n[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)\n[![NPM version](https://img.shields.io/npm/v/nuxt-maintenance-mode.svg?style=flat)](https://npmjs.com/package/nuxt-maintenance-mode)\n[![NPM downloads](https://img.shields.io/npm/dm/nuxt-maintenance-mode.svg?style=flat)](https://npmjs.com/package/nuxt-maintenance-mode)\n[![CircleCI](https://circleci.com/gh/potato4d/nuxt-maintenance-mode/tree/master.svg?style=shield)](https://circleci.com/gh/potato4d/nuxt-maintenance-mode/tree/master)\n\nA module for displaying the view for maintenance as fallback while maintaining the path.\n\n\u003ca href=\"https://patreon.com/potato4d\"\u003e\n  \u003cimg src=\"https://c5.patreon.com/external/logo/become_a_patron_button@2x.png\" height=\"50\"\u003e\n\u003c/a\u003e\n\n[![Image from Gyazo](https://i.gyazo.com/96e9a69d2e6449d774c304f827468430.gif)](https://gyazo.com/96e9a69d2e6449d774c304f827468430)\n\n## About this module\n\nA module for displaying the view for maintenance as fallback while maintaining the path.\n\nInstead of accessed routing, render the contents of the routing specified for maintenance and return status code 503 to the client.\n\nThis is the easiest and most effective way to put an application in maintenance state without compromising the SEO and the user's access experience.\n\n### Caution\n\nThis project is under development.\n\nWe welcome aggressive pull requests such as when there is a better implementation.\n\n## Installation\n\nAt first, install package from NPM\n\n```bash\n$ yarn add nuxt-maintenance-mode # or npm i -S\n```\n\nNext, Add 'nuxt-maintenance-mode' value to modules property in nuxt.config.js\n\n```js\nmodule.exports = {\n  // ...\n  modules: ['nuxt-maintenance-mode']\n  // ...\n}\n```\n\nLast, Add maintenance mode options to nuxt.config.js\n\n```js\nmodule.exports = {\n  // ...\n  modules: [\n    'nuxt-maintenance-mode'\n  ],\n  maintenance: {\n    enabled: !!process.env.MAINTENANCE_MODE, // If given truthy value, activation maintenance mode on startup your nuxt application.\n    path: '/maintenance', // maintenance fallback content routing.\n    matcher: /^\\/admin/ // Path to be in maintenance mode (regex).\n  },\n  // ...\n}\n```\n\n## Options\n\n### enabled?: boolean\n\n- default: false\n- required: false\n\nIf given truthy value, activation maintenance mode on startup your nuxt application.\n\nWe recommend specifying the value of the environment variable.\n\n### path: string\n\n- default: undefined\n- required: true\n\nmaintenance fallback content routing.\n\nThe path you set for this property must have a valid routing.\n\nFor example, if you specify `/maintenance`, create `pages/maintenance.vue`.\n\n### matcher?: string\n\n- default: undefined\n- required: false\n\nPath to be in maintenance mode (regex).\n\n## LICENSE\n\nMIT (c) HANATANI Takuma(@potato4d)\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore --\u003e\n\u003ctable\u003e\u003ctr\u003e\u003ctd align=\"center\"\u003e\u003ca href=\"https://potato4d.me\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/6993514?v=4\" width=\"100px;\" alt=\"Takuma HANATANI\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eTakuma HANATANI\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/potato4d/nuxt-maintenance-mode/commits?author=potato4d\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#maintenance-potato4d\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e \u003ca href=\"https://github.com/potato4d/nuxt-maintenance-mode/commits?author=potato4d\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/potato4d/nuxt-maintenance-mode/issues?q=author%3Apotato4d\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e\u003c/td\u003e\u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/chrysanthos\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/7782312?v=4\" width=\"100px;\" alt=\"Chrysanthos\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eChrysanthos\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/potato4d/nuxt-maintenance-mode/issues?q=author%3Achrysanthos\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpotato4d%2Fnuxt-maintenance-mode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpotato4d%2Fnuxt-maintenance-mode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpotato4d%2Fnuxt-maintenance-mode/lists"}