Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/quasarframework/vue-cli-plugin-quasar

Quasar Framework Vue CLI plugin
https://github.com/quasarframework/vue-cli-plugin-quasar

ios-theme material-design material-theme quasar-framework vue vue-cli-plugin vue-components vuejs vuejs2

Last synced: 18 days ago
JSON representation

Quasar Framework Vue CLI plugin

Host: GitHub
URL: https://github.com/quasarframework/vue-cli-plugin-quasar
Owner: quasarframework
License: mit
Created: 2018-05-03T09:13:42.000Z (over 6 years ago)
Default Branch: dev
Last Pushed: 2024-09-17T10:23:21.000Z (2 months ago)
Last Synced: 2024-10-15T08:23:03.398Z (about 1 month ago)
Topics: ios-theme, material-design, material-theme, quasar-framework, vue, vue-cli-plugin, vue-components, vuejs, vuejs2
Language: JavaScript
Homepage: https://quasar.dev
Size: 160 KB
Stars: 68
Watchers: 5
Forks: 14
Open Issues: 10
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

![Quasar Framework logo](https://cdn.quasar.dev/logo-v2/header.png)

# Quasar Framework: vue-cli-plugin-quasar

> :rocket: Start building a Vue app with Quasar Framework v2 in 2 minutes!

> :warning: **For the premium (and recommended) experience with Quasar, including the ability to build Mobile & Electron apps and efortless upgrades to new Quasar versions, you should instead use Quasar CLI**

[![Join the chat at https://discord.gg/5TDhbDg](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/5TDhbDg)

Please submit a PR to https://github.com/quasarframework/quasar-awesome with your website/app/Quasar tutorial/video etc. Thank you!

## Getting started

:warning: Make sure you have vue-cli v5:

```
vue --version
```

If you don't have a project created with vue-cli v5 yet:

```
vue create my-app
```

Navigate to the newly created project folder and add the cli plugin. Before installing it, make sure to commit your current changes should you wish to revert them later.

```
$ cd my-app
$ yarn add --dev vue-cli-plugin-quasar
$ vue invoke quasar
```

It will ask you if you want the plugin to replace some existing files. It is recommended that you do it if you wish to have an example so you can quickly develop your app.

Your Vue config (in package.json or vue.config.js file, depending on what you chose when you created your vue app) will also contain a `quasar` Object.

## Supporting Quasar
Quasar Framework is an MIT-licensed open source project. Its ongoing development is made possible thanks to the support by these awesome [backers](https://github.com/rstoenescu/quasar-framework/blob/dev/backers.md).

**Please read our manifest on [Why donations are important](https://quasar.dev/why-donate)**. If you'd like to become a donator, check out [Quasar Framework's Donator campaign](https://donate.quasar.dev).

## Documentation

Head on to the Quasar Framework official website: [https://quasar.dev](https://quasar.dev)

## Stay in Touch

For latest releases and announcements, follow on Twitter: [@quasarframework](https://twitter.com/quasarframework)

## Community Forum

Head on to the official community forum: [https://forum.quasar.dev](https://forum.quasar.dev)

## Quasar Repositories

* [Quasar Framework](https://github.com/quasarframework)

## Contributing

I'm excited if you want to contribute to Quasar under any form (report bugs, write a plugin, fix an issue, write a new feature).

### Issue Reporting Guidelines

**Please use the appropriate Github repo to report issues. See "Related Components" above.** For example, a bug related to CLI should be reported to the CLI repo, one related to build issues to Quasar Framework Templates repo and so on.

- The issue list of the repository is **exclusively** for bug reports and feature requests. For anything else please use the [Community Forum](https://forum.quasar.dev).

- Try to search for your issue, it may have already been fixed in the development branch or it may have a resolution.

- Check if the issue is reproducible with the latest stable version of Quasar. If you are using a pre-release, please indicate the specific version you are using.

- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear repro steps will not be triaged. If an issue labeled "need repro" receives no further input from the issue author for more than 5 days, it will be closed.

- 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.

## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)