@bildvitta/quasar-app-extension-asteroid

A Quasar App Extension

Usage no npm install needed!

<script type="module">
  import bildvittaQuasarAppExtensionAsteroid from 'https://cdn.skypack.dev/@bildvitta/quasar-app-extension-asteroid';
</script>

README

Asteroid

This App Extension contains methods, components and styles that will assist in building a C.R.U.D. using Vue and Quasar. It was initially designed to be used in accordance with [our API] standards (http://github.com/bildvitta/api), but can be adapted to any back-end as long as it maintains the original standards.

Note: Some Quasar components must be imported manually inside quasar.config.js (e.g., when you are using QasFormView you have to import QPage).

Structure

Environment variables

| Variables | Description | |:-|:-| | BUCKET_URL | Hosting address of assets. | | SERVER_BASE_URL | Base server access address. |

Instalation

$ quasar ext add @bildvitta/asteroid

Usage

After the installation the app-extension is ready to be used, check here the documentation.

Develop usage

$ git clone https://github.com/bildvitta/asteroid

In root folder:

$ npm i

Go to /app-extension folder:

$ npm i
$ npm link

Now go to /ui folder:

$ npm i
$ npm link

You have linked your app-extension and ui folder, go to the project that you are using asteroid and link them. Inside your project:

$ npm link @bildvitta/quasar-app-extension-asteroid
$ npm link @bildvitta/quasar-ui-asteroid

Now your project is linked with asteroid directory and not anymore with is installed within node_modules of project. For unlink asteroid directory, inside your project:

$ npm i

Storybook and Jest develop usage

$ git clone https://github.com/bildvitta/asteroid

Go to /ui folder:

$ npm i

Storybook and Jest needs vue as a dependency, to install it run the code inside /ui folder:

$ npm run install-peer

Run storybook:

$ npm run storybook

Run all tests:

$ npm run test

Run tests in watch mode:

$ npm run test:watch

Note: If asteroid is linked with some project and you run npm run install-peer the components will stop working inside the project because of vue dependency, to make they work again, inside the /ui folder run:

$ npm i

But now you have lost the link, run again:

$ npm link

Uninstall

$ quasar ext remove @bildvitta/asteroid

Donate

If you appreciate the work that went into this project, please consider donating to Quasar.

License

MIT (c) Caio Tarifa caiotarifa@gmail.com