https://github.com/nomocas/clean-embed-video
a fork of embed-video (should refork from last version and merge)
https://github.com/nomocas/clean-embed-video
Last synced: about 2 months ago
JSON representation
a fork of embed-video (should refork from last version and merge)
- Host: GitHub
- URL: https://github.com/nomocas/clean-embed-video
- Owner: nomocas
- Created: 2017-07-08T11:59:31.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-18T18:12:54.000Z (about 2 years ago)
- Last Synced: 2024-04-14T11:02:06.759Z (about 1 year ago)
- Language: JavaScript
- Size: 185 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# ES6 module boilerplate with full ES6 test suits and coverage
- ES6 sources
- transpiled with [babel](https://babeljs.io) (to dist/es5/*)
- bundled with [rollup](https://github.com/rollup/rollup) (to dist/bundles/*)
- ES6 tests with [mocha](https://mochajs.org) and [chai](http://chaijs.com/) (runned directly from es6 with [babel-register](https://babeljs.io/docs/usage/babel-register/))
- [karma](http://karma-runner.github.io) runner with on-the-fly rollup/babel bundling
- Code coverage with [istanbul](https://istanbul.js.org/) and [nyc](https://github.com/istanbuljs/nyc) directly from ES6 tests and sources (no bundle)
- [coveralls](https://coveralls.io) reporting
- [standard-version](https://github.com/conventional-changelog/standard-version) for semver management and Changelog.md generation.
- [travis.ci](https://travis-ci.org/) config file
- [esdoc](https://esdoc.org) config file
- [eslint](http://eslint.org) ES6 base config for src and test
## Usage
clone this repo then :
```
> npm i
```
or
```
> yarn
```
then :
- build : `> npm run build`
- test : `> mocha` or `> npm test`
- karma : `> npm run karma`
- cover : `> npm run cover`
- es5-watch : `> npm run es5-watch`
- bundles-watch : `> npm run bundles-watch`
## Produced outputs
- dist/es5/* : commonjs unbundled files (transpiled with babel)
- dist/bundles/index.js : cjs module
- dist/bundles/index.min.js : cjs module minified with uglifyjs
- dist/bundles/index.mjs : ES module
## For coveralls
Travis is configured to run coveralls by default.
So either you remove coveralls run in travis config file, or add a .coveralls.yml with your "repo_token: ......" before pushing to travis (after a first manual `npm run coveralls`).
## Licence
The [MIT](http://opensource.org/licenses/MIT) License
Copyright 2017 (c) Gilles Coomans
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.