About

A Vue component library based on CodyHouse UI. This package includes components for assembling website blocks and admin ui. This package was built using vue-sfc-rollup.

Install from NPM

npm install [coming-soon]

Install Locally

If you want to use this package in another local Vue project, you can "link" it to that project. This creates a symbolic link from your other projects' node_modules to your local clone of this package. This way, changes to this package can immediately be reflected in your consuming project.

From within this packages' directory, run:

npm link

From within your consuming projects' directory, run:

npm link vue-component-library

Now you can install via your local path to the library. [package-local-path] should be the local folder where the package is present, Path is the location of the folder containing the package ( local_module ) you want to install:

npm install [package-local-path]

#Example: npm install /Users/heyharmon/Documents/Code/vue-component-library

Use the package like any other package you installed from NPM:

<script>
import { AppButton } from '@bloomcu/vue-component-library'
...
</script>

Dependency not found? Delete "package.lock" and run:

Uninstall Locally

Run:

npm unlink @bloomcu/vue-component-library

And:

npm remove @bloomcu/vue-component-library

Local Package Development

Contributing to this package? Clone it anywhere you keep your projects and work on the package like you would any typical Vue project.

Clone repository:

git clone https://github.com/bloomcu/vue-component-library.git

Install dependencies:

npm install

Build the package:

npm run build

Preview package without a consuming app:

npm run serve

View package dev screen at: http://localhost:7000

Updating Package

When you are finished developing, semantically bump the version in package.json:

{
"version": "0.0.3",
...
}

Build the package:

npm run build

Publishing to NPM

You must be a user on BloomCU's NPM organization to publish new versions of the package. If you are not, you can submit a pull request to the repository and someone else will review your code and publish it to NPM.

Log into NPM if you are not already:

npm adduser

Publish:

npm publish