isabella232 / module-template

Starter template for Nuxt.js Modules

Using this template

1. Clone this repo locally

   npx degit https://github.com/nuxt-community/module-template.git my-new-project
   cd my-new-project
   yarn # or npm install

2. Search and replace all templated names:

   • npm_package => the name of your chosen npm package - e.g. @nuxtjs/http
   • myModule => a camel-cased version of your npm package for namespacing your module options - e.g. http
   • github_repo => your GitHub repo - e.g. nuxt-community/http-module

3. Remove this section of the README.md and dive in!

---

npm_package

📖 Release Notes

Setup

1. Add npm_package dependency to your project

yarn add npm_package # or npm install npm_package

2. Add npm_package to the modules section of nuxt.config.js

{
  modules: [
    'npm_package',
  ],
  myModule: {
    // module options
  }
}

Development

1. Clone this repository
2. Install dependencies using yarn install
3. Start development server using yarn dev

License

MIT License