https://github.com/simonfinney/npm-jumpstart
An opinionated npm boilerplate
https://github.com/simonfinney/npm-jumpstart
boilerplate cli npm-package
Last synced: 25 days ago
JSON representation
An opinionated npm boilerplate
- Host: GitHub
- URL: https://github.com/simonfinney/npm-jumpstart
- Owner: SimonFinney
- Created: 2018-05-20T22:46:25.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T19:00:05.000Z (over 3 years ago)
- Last Synced: 2024-04-24T13:45:58.997Z (about 2 years ago)
- Topics: boilerplate, cli, npm-package
- Language: JavaScript
- Homepage:
- Size: 827 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# npm-jumpstart
An opinionated npm boilerplate
## Features
* [`babel-preset-env`](https://babeljs.io/env/) compiler and [webpack](https://webpack.js.org/) development configuration
* [Jest](https://facebook.github.io/jest/) testing platform
* [eslint](https://eslint.org/) linting utility with [recommended configuration](https://eslint.org/docs/rules/)
* [Prettier](https://prettier.io/) opinionated code formatter with configuration
* [Husky](https://github.com/typicode/husky) pre-commit hooks and [lint-staged](https://github.com/okonet/lint-staged) configuration
* [commitlint](http://marionebl.github.io/commitlint) commit conventions with [Conventional Commits](https://conventionalcommits.org/) configuration
* [Travis CI](https://travis-ci.org/) configuration
* [semantic-release](https://semantic-release.gitbooks.io/semantic-release/content/#highlights) automated version management and package publishing
## Installation
**Note -** This boilerplate requires [Yarn](https://yarnpkg.com/en/) to use out-of-the-box.
```bash
# npm
npm i -g npm-jumpstart
# Yarn
yarn global add npm-jumpstart
```
## Usage
* Run `npm-jumpstart` to create a boilerplate in the current working directory
* Install the generated boilerplate dependencies - `npm i` or `yarn`