βͺοΈ Deprecated: Please migrate to new Starter Template using Module Builder
Module Template for Nuxt.js
Nuxt.js module template
Features
- ESLint
- Ready tests using Jest
- Code coverage
- Github Actions
- Standard Version
Create a Nuxt Module
This is a template for vue-cli. Make sure to use a version of vue-cli >= 2.1 (vue -V) is installed. If you don't already have it, just install it.
npx @vue/cli init nuxt-community/module-template <module-name>
cd <module-name>
yarn install # or npm install
Then, just head to Modules Guide for more help.
Development
For easier development you can use yarn link or npm link to link to your project.
Then start build using npm run dev
.
Publishing
npm run release
Getting known
Don't forget to:
- Add nuxt-module Github topic
- Submit a PR in awesome-nuxt when your module was ready ;)
- Mention us when you have your first release on our Twitter (@nuxt_js)