https://github.com/ganapativs/npm-minimal-boilerplate

Minimal boilerplate for creating NPM packages
https://github.com/ganapativs/npm-minimal-boilerplate

babel boilerplate decorators es6 es7 es8 eslint library module nodejs npm packages

Last synced: 23 days ago
JSON representation

Minimal boilerplate for creating NPM packages

• Host: GitHub
• URL: https://github.com/ganapativs/npm-minimal-boilerplate
• Owner: ganapativs
• License: mit
• Created: 2018-05-01T07:13:23.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-01T07:14:32.000Z (almost 7 years ago)
• Last Synced: 2024-12-11T19:55:38.442Z (about 2 months ago)
• Topics: babel, boilerplate, decorators, es6, es7, es8, eslint, library, module, nodejs, npm, packages
• Language: JavaScript
• Homepage:
• Size: 29.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Minimal boilerplate for creating NPM packages

Boilerplate to get started with NPM package instantly.

## Features

- ES6, ES7, ES8 support

- [Class properties support](https://github.com/tc39/proposal-class-fields)

- Decorators support

- [ESLint](http://eslint.org/) with [AirBnB Base style guide](https://www.npmjs.com/package/eslint-config-airbnb-base) & [Prettier](https://github.com/prettier/prettier)

- Transpilation to ES5

## Usage

1. Clone the repo: `git clone https://github.com/ganapativs/npm-minimal-boilerplate.git my-awesome-npm-package && cd $_`

2. Remove .git: `rm -rf .git`

3. Install dependencies: `yarn`

4. Lint: `yarn run lint`

5. Fix lint issues and prettify code 😎: `yarn run lint-fix`

6. Transpilation to ES5 in `dist` folder: `yarn run prepublish` (standard npm hook)

7. [Push package to your own Github repository](https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/)

8. Publish package: `yarn run publish`

## Todo

- [ ] Test cases

## License

MIT