Skip to content

mingfengwan/mdbootstrap-academic

Repository files navigation

MDB 5 Academic Portfolio Template

Built with Material Design for Bootstrap 5 (💗 by its creators) and Font Awesome 6 Pro.

Home Page Screenshot

Features

Brand-new designs for Coursework, Publication, and Academic Service sections, plus a photo slider page.

Course Work Section Screenshot
Coursework Section
Publication Section Screenshot
Publication Section
Service Section Screenshot
Service Section

Optimized performance

This template underwent thorough tree shaking and achieved an impressive speed score, even with the inclusion of a large-sized WebP file.

Google Lighthouse Screenshot
Google Lighthouse Screenshot


Usage

If no customization is required, just download index.html and main.js from the distribution folder, then modify the content in index.html. Ensure both files are placed in the same folder. Webpack is only necessary for additional customization. For the photo slider, download photos.html and photos.js.

Color Scheme

Please follow the color scheme for MDBootstrap when changing or adding colors.

Webpack

Installation

npm install

A free version of MDB UI Kit and a paid version of Font Awesome are already included as a dependencies, in package.json. Upgrade to paid or downgrade to free as you like.

Dev Server

npm run start

Build

npm run build

Features:

Files structure:

mdbootstrap-academic/
├── dist/
│   └── index.html
├── src/
│   ├── js/
│   └── scss/
├── webpack.config.js
└── package.json

MDB UI KIT

In this project, I imported Collapse, Tooltip, Ripple, Carousel. You can remove Tooltip and Carousel if you are not using these UI components.

Importing JS modules

You can import the entire library (not recommended):

import * as mdb from 'mdb-ui-kit'; // lib

or just individual modules:

import { Input } from 'mdb-ui-kit'; // module
import { Input as CustomInput } from 'mdb-ui-kit'; // module with custom name

Importing CSS file

You can modify my imports in main.scss, as recommended by MDB's guide.

Alternatively, you can import the entire MDB stylesheet:

@import '~mdb-ui-kit/css/mdb.min.css';