Overview

This boilerplate is a set of utilities and plugins for NodeJs to tune and streamline your MDBootstrap experience for greater productivity. This boilerplate follows the Airbnb-style guide for JavaScript found here.

Huge thanks to the developers of MDBootstrap for creating such an in-depth and awesome UI-Kit.

Using the Free version of MDB?
Consider upgrading to the Pro version for even more features!
MDBootstrap Upgrade

Installation

First time installation process for both Free and Pro users:

npm install

• If you're only using the Free version, you're good to go!

• For those who use the Pro version, you need to send an email to contact@mdbootstrap.com and request access to the GitLab repo if you haven't done so already. Once you have access, login and go to your settings, then follow the steps in the image below.
  

  
  

  Once done, the page will update and at the top, a new field will appear called Your New Personal Access Token.

  Remember this access token as you'll never be able to see it again once/if you leave this page. With this access token, run the following commands inside the project, remember to replace ACCESS_TOKEN with your actual token:

  npm uninstall mdbootstrap
  npm install git+https://oauth2:ACCESS_TOKEN@git.mdbootstrap.com/mdb/jquery/jq-pro.git#4.7.7 --save

  Notice: You'll get warned that there are 8 vulnerabilities through NPM, you do not need to worry about these. Finally, you'll need to update the paths in /src/app.js and /src/scss/style.scss from ~mdbootstrap to ~mdbootstrap-pro. Remember to uncomment and/or add any of the pro addons that you need.

Start development server

npm start

Runs the project with webpack-dev-server, opens in a new tab on your default browser. Live-reload enabled.

Building your project

npm run build

Builds the project to /dist/

Updating

When you want to update the project, it's dependencies and packages, I recommend installing npm-check-updates

npm i npm-check-updates -g

Once installed, run the following commands inside the repository:

ncu -u

If packages are updated, run:

npm install

Otherwise you are good to go. To update the version of MDBootstrap you use, just uninstall mdbootstrap through npm and re-install the package. NCU most likely will not update these packages because we currently force version 4.7.7 instead of the latest HEAD version.