yilber/bootstrap4-boilerplate

Front end boilerplate based on Bootstrap 4 and Sass. The javascript files for Bootstrap are compiled with Gulp, babel and rollup.

Bootstrap 4 boilerplate with Sass.

Prerequisites

You will need the following installed on your computer.

• Git
• Node.js (with NPM)

Installation

Clone this repo to your computer and run npm install to install all the dependencies.

git clone https://github.com/Yilber/bootstrap4-boilerplate.git
cd boilerplate

install gulp, rollup, @babel/core, @babel/cli and cross-env globally

npm install -g gulp@^3.9.1 rollup@^0.57.1 @babel/[email protected] @babel/[email protected] cross-env@^5.1.3

install the all the packages

npm install

How to start the server

Starting the server will compile everything. Here's how to do it.

gulp watch

Scaffolding

├── src
│   ├── data
│   ├── fonts
│   ├── images
│   ├── js
│   │   ├── vendor
│   │   ├── main.js
│   │   └── plugin.js
│   └── scss
│       ├── theme
│       ├── bootstrap.scss
│       └── style.scss
├── dist
│   ├── css
│   │   ├── fonts
│   │   └── style.min.css
│   ├── data
│   ├── images
│   ├── js
│   │   ├── bootstrap.bundle.js
│   │   ├── bootstrap.bundle.js.map
│   │   ├── bootstrap.bundle.min.js
│   │   ├── jquery.min.js
│   │   └── main.min.js
│   ├── templates
│   │   ├── footer.php
│   │   └── header.php
│   ├── .htaccess
│   ├── 404.html
│   ├── 404.php
│   ├── index.html
│   └── index.php
├── docs
│   └── README.md
├── .babelrc.js
├── .editorconfig
├── .eslintrc
├── .gitignore
├── config.js
├── gulpfile.js
├── LICENSE
├── package.json
├── README.md
├── rollup.config.js
└── server.js

Todo

List of things to fix or add

• Improve README.md: add documentation, images etc...
• Add CSS linting
• Add testing: Mocha?
• Browser support: Modernizr
• Add an engine template:Nunjucks, Handlebars, Pug(Jade) or another one

Bugs

If you have questions, feature requests or a bug you want to report, please click here to file an issue.

License

Copyright (c) 2018 Yilber Mejia.

Usage is provided under the MIT License. See LICENSE for the full details.