Skip to content

Latest commit

 

History

History
79 lines (50 loc) · 2.71 KB

README.md

File metadata and controls

79 lines (50 loc) · 2.71 KB
Raw

@certego/certego-ui

NPM Node.js Package

Certego components library. Built on React.js + reactstrap + more.

Projects using certego-ui

Install

npm install --save @certego/certego-ui

Documentation

Use local build of certego-ui with hot-reload (for faster development)

You can configure your local development environment in a way that any change in the certego-ui directory will trigger a new build which, in turn, will trigger a new build of your project. This will save you a lot of development time and headache.

$ git clone [email protected]:certego/certego-ui.git /home/user/certego-ui
  • Install dependencies and start local dev server,
/home/user/certego-ui$ npm install
/home/user/certego-ui$ npm start
  • In your other project that uses certego-ui, open the package.json file and modify under "dependencies" to "@certego/certego-ui": "/home/user/certego-ui".
  • Now re-install dependencies and start local dev server,
/home/user/certego-ui$ npm install
/home/user/certego-ui$ npm start

Start example project

  • Open a terminal and start local dev server for certego-ui,
/home/user/certego-ui$ npm start
  • Open another terminal and start local dev server for the certego-ui/example app,
/home/user/certego-ui/example$ npm install
/home/user/certego-ui/example$ npm start

Create new release (github & npm)

  • Modify version attribute inside package.json file and run npm install in a terminal.
  • Modify CERTEGO_UI_VERSION variable in example/src/layouts/AppFooter.jsx file.
  • Write a new entry in the CHANGELOG.md file describing the changes.
  • Finally, you should create a new release on the GitHub repistory by going to this link.

New release on GitHub will automatically publish new release on npmjs.com and, re-build and deploy the example application as well.

Changelog

CHANGELOG.md

License

MIT © certego