https://github.com/miniarray/monorail
Windows metro UI Components for Vue
https://github.com/miniarray/monorail
components library metro toolkit ui uikit vue vuejs windows
Last synced: 6 months ago
JSON representation
Windows metro UI Components for Vue
- Host: GitHub
- URL: https://github.com/miniarray/monorail
- Owner: miniArray
- License: mit
- Created: 2018-03-13T19:40:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-17T16:59:56.000Z (about 7 years ago)
- Last Synced: 2025-03-08T09:38:00.775Z (7 months ago)
- Topics: components, library, metro, toolkit, ui, uikit, vue, vuejs, windows
- Language: Vue
- Homepage: https://monorail.rocks
- Size: 672 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/code_of_conduct.md
Awesome Lists containing this project
README
Metro UI compent library for Vue.js
# Introduction
monorail is a metro UI component framework for [Vue.js](https://vuejs.com). It aims to provide clean, semantic and reusable components that make building your web based windows application a breeze.
## Browser Support
monorail supports **[evergreen browsers](https://www.techopedia.com/definition/31094/evergreen-browser)**, mobile, laptop & desktop.
# Documentation
You can find the monorail documentation [on the website](http://monorail.rocks).
## One minute Quick-start
[Codepen link](http://starter.monorail.rocks)
```html
new Vue({
el: '#app'
})
```
# Installation
## Modern
```bash
$ npm install @miniarray/monorail
$ npm install vue metro4 # dependencies
```
```js static
import Vue from 'vue'
import Monorail from '@miniarray/monorail/src'
import 'metro4/build/css/metro-all.css' // Required for CSS styles
Vue.use(Monorail)
```
## CDN
```html
```
# Running The Test Suite
**Console:**
Installed the dependencies, via:
```bash
npm install
```
then you can run the tests (and get detailed output) by running:
```bash
npm test
```
# Community Support
Ask your support questions on the [monorail Discord Community](http://chat.monorail.rocks).
## Contributing
Developers interested in contributing should read the [Code of Conduct](./docs/code_of_conduct.md).
> Please do **not** ask general questions in an issue. Issues are only to report bugs, request
enhancements, or request new features. For general questions and discussions, ask on the [monorail Discord Community](http://chat.monorail.rocks).
It is important to note that for each release, the detailed changes are documented in the [release notes](http://releases.monorail.rocks).
### Contributing Guide
You can report issues by following the [Issue Template](http://issues.monorail.rocks) and you can create a minimal reproduction with a [CodePen template](http://template.monorail.rocks) or a full project at [CodeSandbox](https://codesandbox.io/s/vue).
We also have a list of [help wanted](http://help.monorail.rocks) issues that you might want to check.
# License
monorail is [MIT licensed](./LICENSE).