ui-library

This project contains all of the base Vue components and assets needed to create iDonate pages and systems.

This project makes use of storybook so you can browse the component library and find documentation and examples with ease.

Using

Install @idonatedev/ui-library from NPM.

Then you can import components:

import Component from "@idonatedev/ui-library/components/Component";
import Page from "@idonatedev/ui-library/pages/Page";

Sometimes components utilize constants like enums to help make selecting options easier in your code. All constants should be available from the same path as named exports:

import Button, { ButtonMode } from "@idonatedev/ui-library/components/button;

Developing Components

TODO

Publishing

1. Update version number in package.json
   • confirm that everything builds cleanly with npm pack
2. Commit package.json changes to release/<version_number> branch
3. Open a Pull Request to master

Ideally, another developer would review, merge, and publish your Pull Request.

Publishing a Pull Request that has just been merged into master looks like this:

cd $PROJECT_DIR
git checkout master
git pull

npm publish

Storybook

Simply clone this repo then run:

npm i
npm run storybook

Troubleshooting

Check your npm and node versions. This project was devved against:

node: 14.2.0 npm: 6.14.4