@freesewing/plugin-template

0.2.0 • Public • Published

Freesewing logo

 freesewing
a library for made-to-measure sewing patterns

Travis build Version License Code coverage DeepScan grade Chat on Gitter Become a Patron

plugin-template

All the boilerplate you need to jump-start your freesewing plugin.

You can checkout or fork this repository to start building your own freesewing plugin.

Getting stared

First, clone this repository and cd into it:

git clone git@github.com:freesewing/plugin-template.git
cd plugin-template

Then install all dependencies:

npm install

Writing your plugin

You can now start adding your code to src/index.js. To build your code, run:

npm run build

Check the documentation or the list of freesewing plugins for more info.

Publishing your plugin

When you are getting somewhere, and you're thinking about publishing your own plugin, you'll want to update the following fields in your package.json file:

  • name
  • version
  • description
  • author
  • homepage
  • repository
  • bugs
  • keywords

Basically, search for template and replace it with your plugin name.

Where to get help

Questions? Stuck? The freesewing chat room on Gitter is the best place to ask for help.

Package Sidebar

Install

npm i @freesewing/plugin-template

Weekly Downloads

0

Version

0.2.0

License

MIT

Unpacked Size

368 kB

Total Files

10

Last publish

Collaborators

  • eriese
  • joostdecock