plannr-ui

Plannr UI

Installing

1. Clone this repo to your machine (if using github cli you can gh repo clone codepotatoltd/plannr-ui)
2. npm install

Running

1. Run npm run storybook

This will boot up storybook and automatically open storybook in your browser to preview your components. It auto-reloads whenever components are changed so no need to manually refresh.

Deploying

1. git add -A
2. Commit your changes with a meaningful commit message. git commit -m "added eggplant Icon 🍆🍆🍆
3. Then type ./deploy_patch.sh and hit enter. This will automate the patch release process for you.

But WTF is going on when you run that? I'll explain:

As we're running an NPM package here everything hangs on the version number that's stored in the package.json file. If we change plannr-ui code, the only way the team will see those changes is if we release a new version with a new version number.

So our funky ./deploy_patch.sh script does:

• git pull to merge any upstream changes with your own code
• npm version patch to auto increment the patch version number in package.json
• git add -A with a git commit -m "incremented patch version" too
• git push to make sure that when we publish the package it's using the right version held on the repo
• npm publish to then physically publish the package to npm.

Magic. 🪄

Installing

1. npm install plannr-ui
2. import PlannrUI from 'plannr-ui' in your entry VueJS file
3. Vue.use(PlannrUI)
4. Prosper!