0.5.0 • Published 2 years ago

@deltares/vue-components v0.5.0

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

Delta Vue Components

This is the monorepo for Deltares it's Vue components. We maintain it with lerna.

@deltares/vue-components

This package contains the reusable Vue components to be used in your Deltares projects. For its features and how to use it, look here.

@deltares/design-tokens

This package contains the raw design tokens for the Deltares projects. ⚠️ You probably don't need to include this as a dependency in your projects. If you want the @deltares/vue-components to have the Deltares theme, look at the @deltares/vuetify-theme package. For more info look here

@deltares/vuetify-theme

This package contains the Vuetify theme for Deltares projects. For more info look here

demo-app

This package contains a demo app of how the @deltares/vue-components can be used. Use this app to test the components in a Real World App. For more information about the demo-app look here

Building components in @deltares/vue-components

In the root of this repo, run npm run start. The demo-app project will be build and run, you can reference components from @deltares/vue-components directly. It features hot module reloading as well.

Adding dependencies to packages

Because we use Lerna, we have the posibility to hoist dependencies to the root of the repo, while still have packages with their own package.json. The benefit of this method, is that we have a single node_modules folder at the root of the repo, instead of having multiple in every packages/* folder.

This reduces the amount of duplicate files on your system by quite a lot.

Hoisting packages to the root comes at a cost though. Using npm install <dependency> is not enough.
Example: Say we want to install @vue/test-utils in packages/vue-components/ we have to do this:

$ cd packages/vue-components
$ npm install @vue/test-utils
$ cd ../../
$ npm run hoist