# gulp-es6-rollup-boilerplate

> Boilerplate to start with simple JS project with automation

Latest version **1.0.2** (published 2016-06-28) · 0 weekly downloads

## Install

```sh
npm install gulp-es6-rollup-boilerplate
pnpm add gulp-es6-rollup-boilerplate
yarn add gulp-es6-rollup-boilerplate
bun add gulp-es6-rollup-boilerplate
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2016-06-28 |
| First published | 2016-06-27 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Usman |
| Maintainers | mizmaar3 |
| Keywords | gulp, boilerplate, ES6, ES2015, babel, Automation |

## Links

- npm: https://www.npmjs.com/package/gulp-es6-rollup-boilerplate
- Repository: https://github.com/mizmaar3/gulp-es6-rollup-boilerplate
- Homepage: https://github.com/mizmaar3/gulp-es6-rollup-boilerplate#readme
- Issues: https://github.com/mizmaar3/gulp-es6-rollup-boilerplate/issues
- npm.io page: https://npm.io/package/gulp-es6-rollup-boilerplate

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2016-06-28
- 1.0.1 — 2016-06-27

## README

# gulp-es6-rollup-boilerplate

> Project tested with node v 6.2.2

A very basic boilerplate to start your Javascript project ideally with [ES6](https://babeljs.io/docs/learn-es2015/) script [Rollup](http://rollupjs.org/) module bundler and [Less](http://lesscss.org/) css preprocessor.

- The aim of this package is to start basic web project which usually have JS and css (less css) files, build them for release by compiling ES2015 code and concatenate multiple js and css files into single bundle.

- This boilerplate uses `Rollup` module bundler which makes bundler more efficient than `browserify` or `webpack` as it bundles minimal code and ignore unused modules to get bundled ___see Example Code Explanation at the end___.

> Normally if you require a module, you import the whole thing. ES2015 lets you just import the bits you need, without mucking around with custom builds. It's a revolution in how we use libraries in JavaScript, and it's happening right now.

- Bundling done with simple commands using [Gulp](http://gulpjs.com/) which is famous build system to automate build process.


## Install

First, clone the repo via git:

```bash
git clone https://github.com/mizmaar3/gulp-es6-rollup-boilerplate your-project-name
```

And then install dependencies.

```bash
$ cd your-project-name && npm install
```


## Build

Run this command to build and bundle the project.

```bash
$ npm run build
```

or simple run

```bash
$ gulp
```

To get minified+uglified version of bundle.js please run

```bash
$ npm run release
```


inside your project folder


## Start Server

To start local server please run

```bash
$ npm run start
```

and goto http://127.0.0.1:9800 to test if code worked. You should get some text on the page.


## DevTools

#### Toggle Chrome DevTools

- OS X: <kbd>Cmd</kbd> <kbd>Alt</kbd> <kbd>I</kbd> or <kbd>F12</kbd>
- Linux: <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>I</kbd> or <kbd>F12</kbd>
- Windows: <kbd>Ctrl</kbd> <kbd>Shift</kbd> <kbd>I</kbd> or <kbd>F12</kbd>


## Example Code Explanation

#### The JS folder

- So basically JS folder contains three files. The main file is `main.rollup.js` and ´math.js & person.js´ are utility functions used in main files. Both util files have two utility functions each exported as modules. The `main.rollup.js` only using one module from each utility file and `Rollup` bundler will only include those two functions in bundler.js which are used by `main.rollup.js` and will ignore rest.


#### The LESS folder

- Less folder contains `.less` files which will be compiled with `gulp-less` and concatenated into single file `style.css`, can be found in `dist` folder after building project.

---
_Source: https://npm.io/package/gulp-es6-rollup-boilerplate · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
