Skip to content

dozjs/doz-component-starter

Repository files navigation

doz-component-starter

Boilerplate for creating Doz components

Install

$ git clone https://github.com/dozjs/doz-component-starter.git your-component-folder

Install dev dependencies

$ npm install

Remember

  • Change tag name in index.js and dist/index.html
  • Write your component inside src/ folder
  • Edit package.json with your info
  • Set your remote repo
  • Development:
    • run script start
  • Production:
    • run script build:production
  • Testing:
    • run script test
  • Publish on NPM, you can run scripts below (automatically build for production)
    • release:major (publish a major)
    • release:minor (publish a minor)
    • release:patch (publish a patch)
  • Replace README.md content with README.md.sample

Changelog

You can view the changelog here

License

doz-component-starter is open-sourced software licensed under the MIT license

Author

Fabio Ricali

About

Boilerplate for creating Doz components

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published