b-lib-boilerplate [all b- libs]

Bornfight frontend project based on gulp, es6 and scss

⚠ IMPORTANT NOTICE - module not yet published on npm ⚠

Change:

• package.json > "name": "c-lib-boilerplate"
• package.json > "description": "...."
• package.json > "main": "src/js/LibName.js"
• LibName.js > replace with your lib name in places where it is used
• add keywords to package.json

📦 Getting Started

• install b-lib trough npm or pull ti from git

npm i @bornfight/b-lib

• include b-lib to your JS and SCSS after running npm install

🔨️ Usage

JS

import LibName from "@bornfight/b-lib";

SCSS

@import "~b-lib/src/scss/b-lib.scss";

HTML markup

<p class="b-lib-class">
    Lib Element
</p>

Basic usage tips

• element needs to have ...
• ...

Advanced usage

• ...

💎 Customization

✅ Properties

Option	Type	Default	Example	Description
parentClass	string	element parent	'js-parent'	Element will be wrapped and moved to that parent and not to initial parent element

🚀 Useful to know

1. ...
2. ...
3. ...

📦 Contribute

Gulp based system

• Gulp 4 used
• browsersync for live reload

npm run dev - dev environent with browsersync

License

MIT © Bornfight