edrone-components-lib

How to Run local server of Edrone Components Library
5,597
Install
npm install edrone-components-lib
Latest Version:0.31.1
Vue:2 · 3
Last Updated:Apr 28, 2023
Links: npm
Maintainer: edrone

Edrone Components Library

How to Run local server of Edrone Components Library

cd componenets-lib
npm install
npm run serve

How to add new component to Edrone Components Library

  1. Add new component
src/lib-components/
  • use TypeScript
  • use methods from @vue/composition-api plugin (migration to vue3)
  • use SCSS preprocessor and place styles in separate files in location:
src/lib-scss/
  • for any assets required to build components use location:
src/lib-assets/
  1. Add Unit test for component
tests/

more info goes here

  1. Add component story into storybook
  • include all props, events
stories/
  1. Update changelog
CHANGELOG.md
  1. Run Chromatic (for UI tests and UI review):
  • add environment variable CHROMATIC_PROJECT_TOKEN with project token generated in the Chromatic project's settings (how to set env variable in Linux)
  • npm run chromatic

How to update npm package with new changes

  1. Add new version to package.json
{
  "name": "edrone-components-lib",
  "version": "0.0.3",   //semantic versioning
  "description": "",
...
  1. Build project
npm run build
  1. Connect to edrone npm account via CLI
npm adduser
  • username: ask admin
  • password: ask admin
  • email: ask admin
  • OTP: ask admin
  1. Push new package to www.npmjs.com
npm publish
  1. Update MissionControl and Admin projects with latest version of the package
 "edrone-components-lib": "0.0.3",

Version History

Version Released Vue License
0.31.1 ^2.0.0 || >=3.0.0
0.30.0 ^2.0.0 || >=3.0.0
0.29.0 ^2.0.0 || >=3.0.0
0.28.0 ^2.0.0 || >=3.0.0
0.27.3 ^2.0.0 || >=3.0.0