mirror of
https://github.com/creativetimofficial/vue-material-kit.git
synced 2025-05-23 04:04:22 +08:00
added readme + issues template
This commit is contained in:
Dragos
parent
732084be47
commit
41d1f90cda
40
ISSUE_TEMPLATE.md
Normal file
40
ISSUE_TEMPLATE.md
Normal file
@ -0,0 +1,40 @@
|
||||
# Prerequisites
|
||||
|
||||
Please answer the following questions for yourself before submitting an issue.
|
||||
|
||||
- [ ] I am running the latest version
|
||||
- [ ] I checked the documentation and found no answer
|
||||
- [ ] I checked to make sure that this issue has not already been filed
|
||||
- [ ] I'm reporting the issue to the correct repository (for multi-repository projects)
|
||||
|
||||
# Expected Behavior
|
||||
|
||||
Please describe the behavior you are expecting
|
||||
|
||||
# Current Behavior
|
||||
|
||||
What is the current behavior?
|
||||
|
||||
# Failure Information (for bugs)
|
||||
|
||||
Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template.
|
||||
|
||||
## Steps to Reproduce
|
||||
|
||||
Please provide detailed steps for reproducing the issue.
|
||||
|
||||
1. step 1
|
||||
2. step 2
|
||||
3. you get it...
|
||||
|
||||
## Context
|
||||
|
||||
Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.
|
||||
|
||||
* Device:
|
||||
* Operating System:
|
||||
* Browser and Version:
|
||||
|
||||
## Failure Logs
|
||||
|
||||
Please include any relevant log snippets or files here.
|
||||
21
LICENSE.md
Normal file
21
LICENSE.md
Normal file
@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2018 Creative Tim
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
185
README.md
185
README.md
@ -1,21 +1,176 @@
|
||||
# vue-material-kit
|
||||
# [Vue Material Kit](https://demos.creative-tim.com/vue-material-kit) [](https://twitter.com/home?status=Vue%20Material%20Kit%20-%20Material%20Design%20UI%20Kit%20for%20Vue.js%20https%3A//www.creative-tim.com/product/vue-material-kit%20%23vuejs%20%23ui%20%23kit%20%23vuematerial%20%40creativetim)
|
||||
|
||||
|
||||
 [](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) [](https://discord.gg/E4aHAQy)
|
||||
|
||||
|
||||
|
||||
Vue Material Kit is a beautiful resource built over [Vue Material](https://vuematerial.io/) and [Vuejs](https://vuejs.org/v2/guide/). It will help you get started developing UI Kits in no time. Vue Material Kit is the official Vuejs version of the Original [Material Kit](https://www.creative-tim.com/product/material-kit). Using the UI Kit is pretty simple but requires basic knowledge of Javascript, [Vuejs](https://vuejs.org/v2/guide/) and [Vue Router](https://router.vuejs.org/en/).
|
||||
|
||||
We have created it thinking about things you actually need in a dashboard. Vue Material Kit contains handpicked and optimised Vuejs plugins. Everything is designed to fit with one another. As you will be able to see, the dashboard you can access on Creative Tim is a customisation of this product.
|
||||
|
||||
Let us know what you think and what we can improve 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://s3.amazonaws.com/creativetim_bucket/github/html.png" width="60" height="60" />](https://www.creative-tim.com/product/material-kit)
|
||||
[<img src="https://s3.amazonaws.com/creativetim_bucket/github/react.svg" width="60" height="60" />](https://www.creative-tim.com/product/material-kit-react)
|
||||
[<img src="https://s3.amazonaws.com/creativetim_bucket/github/vuejs.png" width="60" height="60" />](https://www.creative-tim.com/product/vue-material-kit)
|
||||
|
||||
|
||||
| Vue | React | HTML |
|
||||
| --- | --- | --- |
|
||||
| [](https://www.creative-tim.com/product/vue-material-kit) | [](https://www.creative-tim.com/product/material-kit-react) | [](https://www.creative-tim.com/product/material-kit)
|
||||
|
||||
## Demo
|
||||
|
||||
- [Start page](https://demos.creative-tim.com/vue-material-kit)
|
||||
- [Profile page](https://demos.creative-tim.com/vue-material-kit/#/profile)
|
||||
- [Login page ](https://demos.creative-tim.com/vue-material-kit/#/login)
|
||||
- [Landing Page](https://demos.creative-tim.com/vue-material-kit/#/landing)
|
||||
|
||||
[View More](https://demos.creative-tim.com/vue-material-kit).
|
||||
|
||||
|
||||
## Quick start
|
||||
|
||||
Quick start options:
|
||||
|
||||
- Download from [Creative Tim](https://www.creative-tim.com/product/vue-material-kit)
|
||||
|
||||
|
||||
## Documentation
|
||||
The documentation for the Material Kit is hosted at our [website](https://demos.creative-tim.com/vue-material-kit/documentation).
|
||||
|
||||
|
||||
## File Structure
|
||||
|
||||
Within the download you'll find the following directories and files:
|
||||
|
||||
## Project setup
|
||||
```
|
||||
npm install
|
||||
vue-material-kit/
|
||||
|
||||
├── CHANGELOG.md
|
||||
├── README.md
|
||||
├── babel.config.js
|
||||
├── package.json
|
||||
├── public
|
||||
│ └── index.html
|
||||
├── src
|
||||
│ ├── App.vue
|
||||
│ ├── assets
|
||||
│ │ ├── img
|
||||
│ │ └── scss
|
||||
│ │ ├── material-kit
|
||||
│ │ └── material-kit.scss
|
||||
│ ├── components
|
||||
│ │ ├── Badge.vue
|
||||
│ │ ├── Dropdown.vue
|
||||
│ │ ├── Modal.vue
|
||||
│ │ ├── Pagination.vue
|
||||
│ │ ├── Parallax.vue
|
||||
│ │ ├── Slider.vue
|
||||
│ │ ├── Tabs.vue
|
||||
│ │ ├── cards
|
||||
│ │ │ ├── LoginCard.vue
|
||||
│ │ │ └── NavTabsCard.vue
|
||||
│ │ └── index.js
|
||||
│ ├── layout
|
||||
│ │ ├── MainFooter.vue
|
||||
│ │ ├── MainNavbar.vue
|
||||
│ │ └── MobileMenu.vue
|
||||
│ ├── main.js
|
||||
│ ├── plugins
|
||||
│ │ ├── globalComponents.js
|
||||
│ │ ├── globalDirectives.js
|
||||
│ │ ├── globalMixins.js
|
||||
│ │ └── material-kit.js
|
||||
│ ├── router.js
|
||||
│ └── views
|
||||
│ ├── Index.vue
|
||||
│ ├── Landing.vue
|
||||
│ ├── Login.vue
|
||||
│ ├── Profile.vue
|
||||
│ └── components
|
||||
│ ├── BasicElementsSection.vue
|
||||
│ ├── JavascriptComponentsSection.vue
|
||||
│ ├── NavPillsSection.vue
|
||||
│ ├── NavigationSection.vue
|
||||
│ ├── NotificationsSection.vue
|
||||
│ ├── SmallNavigationSection.vue
|
||||
│ ├── TabsSection.vue
|
||||
│ └── TypographyImagesSection.vue
|
||||
└── vue.config.js
|
||||
|
||||
```
|
||||
|
||||
### Compiles and hot-reloads for development
|
||||
```
|
||||
npm run serve
|
||||
```
|
||||
## Browser Support
|
||||
|
||||
### Compiles and minifies for production
|
||||
```
|
||||
npm run build
|
||||
```
|
||||
At present, we officially aim to support the last two versions of the following browsers:
|
||||
|
||||
### Lints and fixes files
|
||||
```
|
||||
npm run lint
|
||||
```
|
||||
<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)
|
||||
- Download Page: https://www.creative-tim.com/product/vue-material-kit
|
||||
- Documentation is [here](https://demos.creative-tim.com/vue-material-kit/documentation)
|
||||
- License Agreement: https://www.creative-tim.com/license
|
||||
- Support: https://www.creative-tim.com/contact-us
|
||||
- Issues: [Github Issues Page](https://github.com/creativetimofficial/vue-material-kit/issues)
|
||||
- For Front End Development - [Material Kit](https://www.creative-tim.com/product/material-kit)
|
||||
|
||||
## Reporting Issues
|
||||
We use GitHub Issues as the official bug tracker for the Vue Material Kit. 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. Check the `CHANGELOG` from your kit on our [website](https://www.creative-tim.com/).
|
||||
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) instead of opening an issue.
|
||||
|
||||
## Licensing
|
||||
|
||||
- Copyright 2018 Creative Tim (https://www.creative-tim.com)
|
||||
- Creative Tim [license](https://www.creative-tim.com/license)
|
||||
|
||||
## Useful Links
|
||||
|
||||
- [More products](https://www.creative-tim.com/bootstrap-themes) from Creative Tim
|
||||
|
||||
- [Vue products](https://www.creative-tim.com/bootstrap-themes/vuejs-themes) from Creative Tim
|
||||
|
||||
- [Tutorials](https://www.youtube.com/channel/UCVyTG4sCw-rOvB9oHkzZD1w)
|
||||
|
||||
- [Freebies](https://www.creative-tim.com/bootstrap-themes/free) from Creative Tim
|
||||
|
||||
- [Affiliate Program](https://www.creative-tim.com/affiliates/new) (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>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user