https://github.com/modularorg/modularbp

⬡ Dead simple modular boilerplate.
https://github.com/modularorg/modularbp

babel boilerplate browsersync cssnext es6 gulp handlebars liquid modular postcss rollup sass static-site-generator

Last synced: 19 days ago
JSON representation

⬡ Dead simple modular boilerplate.

• Host: GitHub
• URL: https://github.com/modularorg/modularbp
• Owner: modularorg
• License: mit
• Created: 2018-01-31T02:55:58.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2020-05-01T18:22:36.000Z (over 4 years ago)
• Last Synced: 2024-09-14T10:58:40.232Z (about 2 months ago)
• Topics: babel, boilerplate, browsersync, cssnext, es6, gulp, handlebars, liquid, modular, postcss, rollup, sass, static-site-generator
• Language: JavaScript
• Homepage:
• Size: 22.5 KB
• Stars: 14
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        


    

        

    



modularBP

Dead simple modular boilerplate.


## Installation

```sh

npm install mbp -g

```

## Usage

```sh

# init your project

mbp init

# run the build system you chose

gulp

```

## Modules

### Build

| Module | Description |

| ------ | ----------- |

| [modularbp-gulp] | Build tasks modules with [gulp] |

### Styles

| Module | Description |

| ------ | ----------- |

| [modularbp-css] | CSS modules with [cssnext] and [PostCSS] |

| [modularbp-sass] | SCSS modules with [Sass] |

| [modularbp-less] | LESS modules with [Less] |

### Scripts

| Module | Description |

| ------ | ----------- |

| [modularbp-mjs] | JavaScript modules with [modularJS] and [Babel] |

| [modularbp-js] | JavaScript modules with [Babel] |

### Views

| Module | Description |

| ------ | ----------- |

| [modularbp-hbs] | HTML modules with [Handlebars] |

| [modularbp-liquid] | HTML modules with [Liquid] |

| [modularbp-swig] | HTML modules with [Swig] |

## Customization

### Base

If you want to further customize the boilerplate to your own structure and files, you can easily clone a GitHub repository with the init command, by specifying the repository name and optionally the destination directory. It will clone first, then install the mbp modules without overwriting your files.

```sh

mbp init  

```

### Config

You can create a `mconfig.json` file to change the default folders structure and set your modules choice to skip the cli questions.

```json

{

  "src": "./src/",

  "dest": "./dist/",

  "build": "./build/",

  "styles": {

    "src": "./src/styles/",

    "dest": "./dist/styles/",

    "main": "main"

  },

  "scripts": {

    "src": "./src/scripts/",

    "dest": "./dist/scripts/",

    "main": "main"

  },

  "svgs": {

    "src": "./src/images/sprite/",

    "dest": "./dist/images/"

  },

  "views": {

    "src": "./src/",

    "partials": "./src/partials/"

  },

  "modules": {

    "build": "gulp",

    "style": "css",

    "script": "mjs",

    "view": "hbs"

  }

}

```

[modularbp-gulp]: https://github.com/modularorg/modularbp-gulp

[modularbp-css]: https://github.com/modularorg/modularbp-gulp/tree/master/modules/gulp-css

[modularbp-sass]: https://github.com/modularorg/modularbp-gulp/tree/master/modules/gulp-sass

[modularbp-less]: https://github.com/modularorg/modularbp-gulp/tree/master/modules/gulp-less

[modularbp-mjs]: https://github.com/modularorg/modularbp-mjs

[modularbp-js]: https://github.com/modularorg/modularbp-gulp/tree/master/modules/gulp-js

[modularbp-hbs]: https://github.com/modularorg/modularbp-gulp/tree/master/modules/gulp-hbs

[modularbp-liquid]: https://github.com/modularorg/modularbp-gulp/tree/master/modules/gulp-liquid

[modularbp-swig]: https://github.com/modularorg/modularbp-gulp/tree/master/modules/gulp-swig

[gulp]: https://github.com/gulpjs/gulp

[cssnext]: https://github.com/MoOx/postcss-cssnext

[Sass]: https://github.com/sass/libsass

[Less]: https://github.com/less/less.js

[PostCSS]: https://github.com/postcss/postcss

[modularJS]: https://github.com/modularorg/modularjs

[Babel]: https://github.com/babel/babel

[Handlebars]: https://github.com/wycats/handlebars.js

[Liquid]: https://github.com/Shopify/liquid

[Swig]: https://github.com/node-swig/swig-templates