Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanwalther/boilerplate-es6
Boilerplate for ES6 projects
https://github.com/stefanwalther/boilerplate-es6
Last synced: about 5 hours ago
JSON representation
Boilerplate for ES6 projects
- Host: GitHub
- URL: https://github.com/stefanwalther/boilerplate-es6
- Owner: stefanwalther
- License: mit
- Created: 2016-06-23T17:05:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T17:47:03.000Z (11 months ago)
- Last Synced: 2024-10-12T01:30:07.848Z (25 days ago)
- Language: JavaScript
- Homepage:
- Size: 27.3 KB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# boilerplate-es6
> boilerplate-es6 is a template for your es6 based projects using
## Install
```sh
## Clone the repo
$ git clone [email protected]:stefanwalther/boilerplate-es6.git
## Install all dependencies
$ npm install
```
## Basic concept
* JavaScript ES6
* ES6 Transpiler
- [babel](https://babeljs.io/)
* Build system
- [gulp](http://gulpjs.com/)
* Test framework
- [mocha](https://mochajs.org/)
- [istanbul](https://istanbul.js.org/) & [nyc](https://github.com/istanbuljs/nyc)
* Code style
- [idiomatic](https://github.com/rwaldron/idiomatic.js/)
- [eslint](http://eslint.org/) (using JS code style idiomatic)
* Documentation
- [verb](https://github.com/verbose/verb)
## Script Tasks
### build
> Build the code from `./src`, store in `./dist`
```sh
$ npm run build
```
### Test
```sh
## Unit tests
$ npm run test:unit
## E2E tests
$ npm run test:e2e
## All tests
$ npm run test
```
### Test coverage
```sh
$ npm run coverage
```
### Linting
```sh
## Lint `./src`
$ npm run lint
## Lint './test`
$ npm run lint:test
```
### Documentation
```sh
## Generated documentation using verb
$ npm run docs
```
## Author
**Stefan Walther**
* [github/stefanwalther](https://github.com/stefanwalther)
* [twitter/waltherstefan](http://twitter.com/waltherstefan)
## License
Released under the MIT license.
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.30, on October 21, 2016._