5 min Quick Start:

Prerequisites:

Before you use MDB Vue make sure you have installed Create vue App package. This package contains development environment that will speed up the development process. Node 6 or higher is required.

To install Create Vue App, in your command line type:

npm install -g @vue/cli

New project:

Step 1: If you haven't downloaded MDB vue package yet, go to Getting Started page and download it now.

Step 2: Unzip downloaded package and open your unpacked directory.

Step 3: For PRO version open package.json file and change REPLACE_WITH_YOUR_TOKEN to your private gitlab access token in mdbvue dependency path.

To install the dependencies, depending on your node module manager, run:


        $ npm install
    

        $ yarn
    

Step 4: Now after you've downloaded everything it's time to write the second command which let us serve our app on localhost using:


        $ npm start
    

        $ yarn start
    

Step 5: When you check what is served at your port 8080 you should see app default screen.

Step 6: Explore our documentation (menu on the left). Choose components you like, copy it to your project and compose your website. And yes, it's that simple!

Step 7: You can also launch our Demonstration Page. The files with the code are placed in the demo directory.


        $ npm demo
    

        $ yarn demo
    

Step 8: If You want to completely remove our demo from Your App, easily type:


        $ npm remove-demo
    

        $ yarn remove-demo
    

Existing project:

Step 1:  Create new vue project using the command:

vue init webpack my-project

Step 2:  cd my-project

Step 3:  Install MDB Vue

npm install --save mdbvue
// OR
yarn add mdbvue

Step 4:  Import style files in Your src/main.js before the App.vue file import:

import 'bootstrap/dist/css/bootstrap.min.css';
import 'mdbvue/build/css/mdb.css';


Step 5: Run your app

npm run start
// OR
yarn start

Step 1:  Create new Vue CLI project using the command:

vue init webpack my-project

Step 2:  cd my-project

Step 3:  GitLab installation

  1. Visit https://git.mdbootstrap.com and log in, if you are PRO user and do not have an account yet, please request one contacting us: contact@mdbootstrap.com
  2. From top right corner click at your avatar and choose "Setting → Access Tokens"
  3. Provide a Name for your token and choose "api" from scopes. Then click "Create personal access token"
    add token
  4. Once your token will be generated make sure to copy it and store in safe place. You won't be able to access it again. In case of lose, you will have to generate new token again.
    token
  5. Navigate to given repository, switch GIT to HTTP and copy it's URL i.e.: https://git.mdbootstrap.com/mdb/vue/vu-pro.git
    repo
  6. Adjust the following link as per below
    "git+https://oauth2: + access_token + @ + repo address" 

    i.e. 

    git+https://oauth2:jFzMYzqSBUmGm3Z1ZA9s@git.mdbootstrap.com/mdb/vue/vu-pro.git
  7. Within existing vue project run:
    npm install git+https://oauth2:jFzMYzqSBUmGm3Z1ZA9s@git.mdbootstrap.com/mdb/vue/vu-pro.git --save // OR yarn add git+https://oauth2:jFzMYzqSBUmGm3Z1ZA9s@git.mdbootstrap.com/mdb/vue/vu-pro.git

    if you don't have existing npm project you should create it first (npm init)

    alternatively, you can update your dependencies in package.json like below:

    "dependencies": {
      "mdbvue": "git+https://oauth2:jFzMYzqSBUmGm3Z1ZA9s@git.mdbootstrap.com/mdb/vue/vu-pro.git"
    }

    Then run npm or npm install to install the dependencies

Step 5:  Import style files in Your src/main.js before the App.vue file import:

import 'bootstrap/dist/css/bootstrap.min.css';
import 'mdbvue/build/css/mdb.css';


Step 5:  Run your app

npm run start
// OR
yarn start