https://github.com/webpro/domtastic-release
https://github.com/webpro/domtastic-release
Last synced: 20 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/webpro/domtastic-release
- Owner: webpro
- Created: 2014-01-17T22:52:50.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2016-03-29T19:35:17.000Z (about 10 years ago)
- Last Synced: 2025-03-10T09:33:01.676Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://domtastic.js.org
- Size: 765 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DOMtastic
Release repository for [DOMtastic](https://domtastic.js.org). These files are what you get when you install the `domtastic` package from npm or Bower. Please refer to the [project page](https://domtastic.js.org) for more documentation, source code, tests, etc.
## Why?
Why isn't the source project itself published to npm and Bower?
* The source files are written in ES6, so you would have to transpile it yourself. This might be an obstacle, or inconvenient.
* It is a bad practice to store generated files in a source repository (i.e. the commonly seen `/dist` folder).
* This gives a nice and clean package repository with just the files you need.
## What?
This repository release contains the following files:
`/domtastic.js`
The UMD bundle, which works with AMD, CommonJS and browser global as fallback. This is also the file served by the [jsDelivr CDN](http://www.jsdelivr.com/) for easy inclusion anywhere. E.g. [//cdn.jsdelivr.net/domtastic/0.11/domtastic.js](https:////cdn.jsdelivr.net/domtastic/0.11/domtastic.js) will give you the most recent `0.11.x` version. Additionally, this might come in handy if you just want to fiddle around to try or test something on e.g. JSFiddle or JS Bin ([JSFiddle example](http://jsfiddle.net/56r00faz/), [JS Bin example](http://jsbin.com/huhixolabo/1/edit?html,js,output)).
`/domtastic.min.js`
The minified production version of `domtastic.js`. Both files come with a `.map` source map file for debugging purposes.
`/amd`
The generated and clean AMD version of the ES6 source, to directly use in your AMD projects (e.g. with Require.js).
`/commonjs`
The generated and clean CommonJS version of the ES6 source. Works well with e.g. Browserify.
## How?
* The release is done with [release-it](https://github.com/webpro/release-it), which has the feature to release any build output to a separate repository & npm.
* The transpilation of ES6 to CommonJS and AMD is done using [Babel](https://babeljs.io).
## License
[MIT](http://webpro.mit-license.org)