mirror of
https://github.com/Hopiu/vue-material.git
synced 2026-05-08 23:44:44 +00:00
Merge remote-tracking branch 'origin/master' into components/mdDialog
* origin/master: Remove extra space Create .github files and improve readme Remove outdated readme
This commit is contained in:
commit
31739aee1a
5 changed files with 130 additions and 48 deletions
64
.github/CONTRIBUTING.md
vendored
Normal file
64
.github/CONTRIBUTING.md
vendored
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
# Vue Material Contributing Guide
|
||||
|
||||
Before submitting your contribution please read the guidelines.
|
||||
|
||||
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
|
||||
- [Pull Request Guidelines](#pull-request-guidelines)
|
||||
- [Development Setup](#development-setup)
|
||||
|
||||
## Issue Reporting Guidelines
|
||||
|
||||
- Always search for your issue first. It may have already been answered, planned or fixed in some branch. New components and features will be planned on [Milestones](https://github.com/marcosmoura/vue-material/milestones) or on [Projects](https://github.com/marcosmoura/vue-material/projects).
|
||||
|
||||
- Only create issues for the newest version. For now. Until 1.0.0.
|
||||
|
||||
- Create a declarative title and describe clearly the steps necessary to reproduce the issue. If an issue labeled "need repro" receives no further input from the issue author for more than 3 days, it will be closed.
|
||||
|
||||
- If you want to show your code please use [Codepen](http://codepen.io/pen/) or [JSFiddle](https://jsfiddle.net/). You could start with [this template](http://codepen.io/vue-material/pen/WGavBE).
|
||||
|
||||
- In case you found a solution by yourself try to explain how you fixed it. It could be useful for somebody else. :)
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
- The `master` branch is basically just a snapshot of the latest stable release. All development should be done in dedicated branches. **Do not submit PRs against the `master` branch.**
|
||||
|
||||
- Work in the `src` or `docs` folder and **DO NOT** add `dist` in the commits.
|
||||
|
||||
- Make small commits as you work on the PR. They will be automatically squashed before merging.
|
||||
|
||||
- Provide convincing reason to add a new feature. Ideally you should open a suggestion/request issue first and have it greenlighted before working on it.
|
||||
|
||||
- If fixing a bug:
|
||||
- If you are resolving a special issue, add the GitHub ID to your commit. E.g. `(fix something really ugly #xxx)`
|
||||
- Provide detailed description of the bug in the PR.
|
||||
|
||||
## Development Setup
|
||||
|
||||
You will need [Node.js](http://nodejs.org) **version 6+**
|
||||
|
||||
After cloning the repo, run:
|
||||
|
||||
``` bash
|
||||
$ npm install
|
||||
```
|
||||
|
||||
### Commonly used NPM scripts
|
||||
|
||||
``` bash
|
||||
### Start dev server with hot reload
|
||||
npm run dev
|
||||
|
||||
### Check for errors
|
||||
npm run lint
|
||||
|
||||
### Build everything
|
||||
npm run build
|
||||
|
||||
### Build docs only
|
||||
npm run build:docs
|
||||
|
||||
### Build lib only
|
||||
npm run build:lib
|
||||
```
|
||||
|
||||
The other tasks on package.json **SHOULD NOT** be executed.
|
||||
45
.github/ISSUE_TEMPLATE.md
vendored
Normal file
45
.github/ISSUE_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
<!--
|
||||
|
||||
Reporting a bug?
|
||||
================
|
||||
- Always search for your issue first. It may have already been answered, planned or fixed in some branch.
|
||||
|
||||
- Make sure to only create issues for the newest version.
|
||||
|
||||
- Create a declarative title and describe clearly the steps necessary to reproduce the issue. If an issue labeled "need repro" receives no further input from the issue author for more than 3 days, it will be closed.
|
||||
|
||||
- If you want to show your code please use [Codepen](http://codepen.io/pen/) or [JSFiddle](https://jsfiddle.net/). You could start with [this template](http://codepen.io/vue-material/pen/WGavBE).
|
||||
|
||||
- In case you found a solution by yourself, it could be helpful to explain how you fixed it.
|
||||
|
||||
- For bugs that involves build setups, you can create a reproduction repository with steps in the README.
|
||||
|
||||
- If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.
|
||||
|
||||
Have a feature request?
|
||||
=======================
|
||||
- Remove the template from below and provide thoughtful commentary.
|
||||
|
||||
- Answer those questions:
|
||||
- What will it allow you to do that you can't do today?
|
||||
- How will it make current work-arounds straightforward?
|
||||
- What potential bugs and edge cases does it help to avoid?
|
||||
|
||||
Do not create new features based on a problem that will only solve edge cases for your project. Remember that Vue Material aims to be lightweight and clean. :)
|
||||
-->
|
||||
|
||||
<!-- BUG REPORT TEMPLATE -->
|
||||
|
||||
### Steps to reproduce
|
||||
|
||||
### Which browser?
|
||||
<!-- Which versions of Vue, Vue Material, OS, browsers are affected? -->
|
||||
|
||||
### What is expected?
|
||||
|
||||
### What is actually happening?
|
||||
<!-- Is there anything else we should know? -->
|
||||
|
||||
### Reproduction Link
|
||||
<!-- If you want to show your code please use Codepen or JSFiddle. -->
|
||||
<!-- You could start with this template: http://codepen.io/vue-material/pen/WGavBE.
|
||||
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<!--
|
||||
Please make sure to read the Pull Request Guidelines:
|
||||
https://github.com/marcosmoura/vue-material/blob/master/.github/CONTRIBUTING.md#pull-request-guidelines
|
||||
-->
|
||||
38
README.md
38
README.md
|
|
@ -1,6 +1,18 @@
|
|||
# Vue.js Material
|
||||
<p align="center">
|
||||
<a href="https://marcosmoura.github.io/vue-material/" target="_blank">
|
||||
<img width="150" src="https://marcosmoura.github.io/vue-material/assets/logo-vue-material-blue.png">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
> Material Design for Vue.js
|
||||
<p align="center">Material Design for Vue.js</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://www.npmjs.com/package/vue-material"><img src="https://img.shields.io/npm/dt/vue-material.svg" alt="Downloads"></a>
|
||||
|
||||
<a href="https://www.npmjs.com/package/vue-material"><img src="https://img.shields.io/npm/v/vue-material.svg" alt="Version"></a>
|
||||
|
||||
<a href="https://www.npmjs.com/package/vue-material"><img src="https://img.shields.io/npm/l/vue-material.svg" alt="License"></a> <br>
|
||||
</p>
|
||||
|
||||
Vue Material is lightweight framework built exactly according to the <a href="http://material.google.com" target="_blank">Material Design</a> specs. It aims to deliver a collection of reusable components and a series of UI Elements to build applications with support to <a href="https://saucelabs.com/u/vuejs" target="_blank">modern Web Browsers</a> through Vue 2.0. Build powerful and well-designed web apps that can can fit on every screen. You can generate and use themes dynamically, use components on demand, take advantage of UI Elements and Components with an ease-to-use API.
|
||||
|
||||
|
|
@ -9,7 +21,7 @@ Vue Material is lightweight framework built exactly according to the <a href="ht
|
|||
|
||||
## Installation
|
||||
|
||||
Import Roboto and Google Icons from Google CDN:
|
||||
Import Roboto and Material Icons from Google CDN:
|
||||
|
||||
``` html
|
||||
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:300,400,500,700,400italic">
|
||||
|
|
@ -92,25 +104,9 @@ Apply your theme using <code>v-md-theme</code> directive:
|
|||
## Changelog
|
||||
<a href="https://marcosmoura.github.io/vue-material/#/changelog" target="_blank">Changelog</a>
|
||||
|
||||
## Build Setup
|
||||
## Contributing
|
||||
|
||||
``` bash
|
||||
### Install dependencies
|
||||
npm install
|
||||
yarn
|
||||
|
||||
### Start dev server with hot reload
|
||||
npm run dev
|
||||
|
||||
### Build everything
|
||||
npm run build
|
||||
|
||||
### Build docs only
|
||||
npm run build:docs
|
||||
|
||||
### Build lib only
|
||||
npm run build:lib
|
||||
```
|
||||
Please make sure to read the [Contributing Guide](https://github.com/marcosmoura/vue-material/blob/master/.github/CONTRIBUTING.md) before making a pull request.
|
||||
|
||||
## Credits and Thanks
|
||||
* This library aims to delivery components using almost the same API of <a href="https://material.angularjs.org/latest/" target="_blank">Angular Material</a>
|
||||
|
|
|
|||
|
|
@ -1,27 +0,0 @@
|
|||
# Vue.js Material Docs
|
||||
|
||||
> Material Design for Vue.js
|
||||
|
||||
## Build Setup
|
||||
|
||||
``` bash
|
||||
### install dependencies
|
||||
npm install
|
||||
|
||||
### serve with hot reload at localhost:8080
|
||||
npm run dev
|
||||
|
||||
### build for production with minification
|
||||
npm run build
|
||||
|
||||
### run unit tests
|
||||
npm run unit
|
||||
|
||||
### run e2e tests
|
||||
npm run e2e
|
||||
|
||||
### run all tests
|
||||
npm test
|
||||
```
|
||||
|
||||
For detailed explanation on how things work, checkout the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader).
|
||||
Loading…
Reference in a new issue