mirror of
https://github.com/creativetimofficial/vue-material-kit.git
synced 2025-05-23 04:04:22 +08:00
208 lines
10 KiB
Markdown
208 lines
10 KiB
Markdown
# [Vue Material Kit 2](http://demos.creative-tim.com/vue-material-kit/#/?ref=readme-vmk) [](https://twitter.com/intent/tweet?url=https://www.creative-tim.com/product/vue-material-kit&text=Check%20Vue%20Material%20kit%20Pro%20made%20by%20@CreativeTim%20#webdesign%20#kit%20#materialdesign%20#vue%20https://www.creative-tim.com/product/vue-material-kit)
|
||
|
||
 [](https://github.com/creativetimofficial/vue-material-kit/issues?q=is%3Aopen+is%3Aissue) [](https://github.com/creativetimofficial/vue-material-kit/issues?q=is%3Aissue+is%3Aclosed)
|
||
|
||
|
||
|
||
Vue Material Kit 2 is our newest free VueJS Design System. Its amazing design is inspired by Material Design and contains all the components you need for your development. If you’re a developer looking to create good-looking websites, rich with features, and highly customisable, here is your match.
|
||
|
||
**Fully Coded Elements**
|
||
|
||
Vue Material Kit 2 is built with over 70 frontend individual elements, like buttons, inputs, navbars, alerts or cards, giving you the freedom of choosing and combining. All components can take variations in color, which you can easily modify using sass files. You will save a lot of time going from prototyping to full-functional code because all elements are implemented.
|
||
|
||
This free VueJS 3 & Bootstrap 5 template is coming with pre-built design blocks, so the development process is seamless,
|
||
switching from our pages to the real website is very easy to be done.
|
||
View [all components here.](https://www.creative-tim.com/learning-lab/vue/alerts/material-kit/)
|
||
|
||
**Documentation built by Developers**
|
||
|
||
Each element is well presented in very complex documentation.
|
||
You can read more about the [documentation here](https://www.creative-tim.com/learning-lab/vue/overview/material-kit/).
|
||
|
||
**Example Pages**
|
||
|
||
If you want to get inspiration or just show something directly to your clients, you can jump-start your development with our pre-built example pages. You will be able to quickly set up the basic structure for your web project.
|
||
|
||
View [example pages here.](https://demos.creative-tim.com/vue-material-kit/)
|
||
|
||
**HELPFUL LINKS**
|
||
|
||
- View [Github Repository](https://github.com/creativetimofficial/vue-material-kit)
|
||
- Check [FAQ Page](https://www.creative-tim.com/faq)
|
||
|
||
#### Special thanks
|
||
|
||
During the development of this dashboard, we have used many existing resources from awesome developers. We want to thank them for providing their tools open source:
|
||
|
||
- [VueJS 3](https://vuejs.org/) - An approachable, performant and versatile framework for building web user interfaces.
|
||
- [Bootstrap 5](https://getbootstrap.com/) - Powerful, extensible, and feature-packed frontend toolkit.
|
||
- [Popper.js](https://popper.js.org/) - Kickass library used to manage poppers
|
||
- [Pinia](https://pinia.vuejs.org/) - The Vue Store that you will enjoy using.
|
||
- [PrismJS](https://prismjs.com/) - A lightweight and extensible syntax highlighter.
|
||
- [TypedJS](https://mattboldt.com/demos/typed-js/) - A JavaScript Typing Animation Library.
|
||
- [Vue Clipboard 3](https://github.com/JamieCurnow/vue-clipboard3) - Easily copy to clipboard in Vue 3.
|
||
- [Vue Count To](http://panjiachen.github.io/countTo/demo/) - A dependency-free, lightweight vue component for count up.
|
||
|
||
Let us know your thoughts below. And good luck with development!
|
||
|
||
## Table of Contents
|
||
|
||
- [Versions](#versions)
|
||
- [Demo](#demo)
|
||
- [Quick Start](#quick-start)
|
||
- [Documentation](#documentation)
|
||
- [File Structure](#file-structure)
|
||
- [Browser Support](#browser-support)
|
||
- [Resources](#resources)
|
||
- [Reporting Issues](#reporting-issues)
|
||
- [Technical Support or Questions](#technical-support-or-questions)
|
||
- [Licensing](#licensing)
|
||
- [Useful Links](#useful-links)
|
||
|
||
## Versions
|
||
|
||
[<img src="https://raw.githubusercontent.com/creativetimofficial/public-assets/master/logos/vue-logo.jpg?raw=true" width="60" height="60" />](https://www.creative-tim.com/product/vue-material-kit?ref=readme-vmk)
|
||
|
||
| VueJS |
|
||
| ----- |
|
||
|
||
| [](http://demos.creative-tim.com/vue-material-kit/?ref=readme-vmk)
|
||
|
||
## Demo
|
||
|
||
- [Landing page](https://demos.creative-tim.com/vue-material-kit/#/pages/landing-pages/about-us?ref=readme-mkrp)
|
||
- [Author page](https://demos.creative-tim.com/vue-material-kit/#/pages/landing-pages/author?ref=readme-mkrp)
|
||
- [Sign in page](https://demos.creative-tim.com/vue-material-kit/#/pages/landing-pages/basic?ref=readme-mkrp)
|
||
|
||
[View More](https://demos.creative-tim.com/vue-material-kit/#/?ref=readme-mkp).
|
||
|
||
## Quick start
|
||
|
||
Quick start options:
|
||
|
||
- Buy from [Creative Tim](https://www.creative-tim.com/product/vue-material-kit?ref=readme-vmk).
|
||
|
||
## Terminal Commands
|
||
|
||
1. Download and Install NodeJs LTS version from [NodeJs Official Page](https://nodejs.org/en/download/).
|
||
2. Navigate to the root ./ directory of the product and run `yarn install` or `npm install` to install our local dependencies.
|
||
|
||
## Documentation
|
||
|
||
The documentation for the Material Kit is hosted at our [website](https://www.creative-tim.com/learning-lab/vue/overview/material-kit/?ref=readme-vmk).
|
||
|
||
### What's included
|
||
|
||
Within the download you'll find the following directories and files:
|
||
|
||
```
|
||
vue-material-kit-2
|
||
├── public
|
||
├── src
|
||
│ ├── assets
|
||
│ │ ├── css
|
||
│ │ ├── fonts
|
||
│ │ ├── img
|
||
│ │ ├── js
|
||
│ │ └── scss
|
||
│ ├── components
|
||
│ │ ├── MaterialAlert.vue
|
||
│ │ ├── MaterialAvatar.vue
|
||
│ │ ├── MaterialBadge.vue
|
||
│ │ ├── MaterialButton.vue
|
||
│ │ ├── MaterialCheckbox.vue
|
||
│ │ ├── MaterialInput.vue
|
||
│ │ ├── MaterialPagination.vue
|
||
│ │ ├── MaterialPaginationItem.vue
|
||
│ │ ├── MaterialProgress.vue
|
||
│ │ ├── MaterialSocialButton.vue
|
||
│ │ ├── MaterialSwitch.vue
|
||
│ │ └── MaterialTextArea
|
||
│ ├── examples
|
||
│ │ ├── cards
|
||
│ │ ├── footers
|
||
│ │ ├── navbars
|
||
│ │ ├── tables
|
||
│ │ ├── Breadcrumbs.vue
|
||
│ │ └── Header.vue
|
||
│ ├── layouts
|
||
│ │ ├── sections
|
||
│ │ │ ├── attention-catchers
|
||
│ │ │ ├── components
|
||
│ │ │ ├── elements
|
||
│ │ │ ├── input-areas
|
||
│ │ │ ├── navigation
|
||
│ │ └── └── page-sections
|
||
│ ├── router
|
||
│ ├── stores
|
||
│ ├── views
|
||
│ │ ├── LandingPages
|
||
│ │ └── Presentation
|
||
│ ├── App.vue
|
||
│ ├── main.js
|
||
│ └── material-kit.js
|
||
├── .eslintrc.json
|
||
├── .gitignore
|
||
├── CHANGELOG.md
|
||
├── ISSUE_TEMPLATE.md
|
||
├── LICENSE.md
|
||
├── index.html
|
||
├── package.json
|
||
├── README.md
|
||
└── vite.config.js
|
||
```
|
||
|
||
## Browser Support
|
||
|
||
At present, we officially aim to support the last two versions of the following browsers:
|
||
|
||
<img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/chrome.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/firefox.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/edge.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/safari.png" width="64" height="64"> <img src="https://s3.amazonaws.com/creativetim_bucket/github/browser/opera.png" width="64" height="64">
|
||
|
||
## Resources
|
||
|
||
- [Live Preview](https://demos.creative-tim.com/vue-material-kit/#/?ref=readme-vmk)
|
||
- [Buy Page](https://www.creative-tim.com/product/vue-material-kit?ref=readme-vmk)
|
||
- Documentation is [here](https://www.creative-tim.com/learning-lab/vue/overview/material-kit/?ref=readme-vmk)
|
||
- [License Agreement](https://www.creative-tim.com/license?ref=readme-vmk)
|
||
- [Support](https://www.creative-tim.com/contact-us?ref=readme-vmk)
|
||
- Issues: [Github Issues Page](https://github.com/creativetimofficial/vue-material-kit/issues)
|
||
|
||
## Reporting Issues
|
||
|
||
We use GitHub Issues as the official bug tracker for the Vue Material Kit 2. Here are some advices for our users that want to report an issue:
|
||
|
||
1. Make sure that you are using the latest version of the Vue Material Kit 2. Check the CHANGELOG from your dashboard on our [website](https://www.creative-tim.com/product/vue-material-kit?ref=readme-vmk).
|
||
2. Providing us reproducible steps for the issue will shorten the time it takes for it to be fixed.
|
||
3. Some issues may be browser specific, so specifying in what browser you encountered the issue might help.
|
||
|
||
## Technical Support or Questions
|
||
|
||
If you have questions or need help integrating the product please [contact us](https://www.creative-tim.com/contact-us?ref=readme-vmk) instead of opening an issue.
|
||
|
||
## Licensing
|
||
|
||
- Copyright 2022 [Creative Tim](https://www.creative-tim.com?ref=readme-vmk)
|
||
- Creative Tim [license](https://www.creative-tim.com/license?ref=readme-vmk)
|
||
|
||
## Useful Links
|
||
|
||
- [More products](https://www.creative-tim.com/templates?ref=readme-vmk) from Creative Tim
|
||
|
||
- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w)
|
||
|
||
- [Freebies](https://www.creative-tim.com/bootstrap-themes/free?ref=readme-vmk) from Creative Tim
|
||
|
||
- [Affiliate Program](https://www.creative-tim.com/affiliates/new?ref=readme-vmk) (earn money)
|
||
|
||
##### Social Media
|
||
|
||
Twitter: <https://twitter.com/CreativeTim>
|
||
|
||
Facebook: <https://www.facebook.com/CreativeTim>
|
||
|
||
Dribbble: <https://dribbble.com/creativetim>
|
||
|
||
Google+: <https://plus.google.com/+CreativetimPage>
|
||
|
||
Instagram: <https://instagram.com/creativetimofficial>
|