Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 2.29 KB

README.md

File metadata and controls

41 lines (31 loc) · 2.29 KB
Raw

dicty-components-header-footer

Travis Coveralls dependencies Status devDependencies Status peerDependencies Status

React components for displaying header and footer in all dictyBase web applications.

Install

npm i dictyBase/dicty-components-header-footer --save

For a particular version(checks tags/release first)
npm i dictyBase/dicty-components-header-footer#v1.0.0 --save

Usage and documentation

import {Header, Footer} from "dicty-components-header-footer

Documentation of Header is here.
Documentation of Footer is here.

Development

  • Clone the develop branch of this repository
  • Run npm install
  • Create a feature branch(feature/foo) or bug/foo or documentation/foo or refactor/foo, whatever suits the purpose of development
  • To run a demo during development
    npm run start
  • Write tests in the same folder as the component. Snapshot testing is recommended.
  • At the end of development, npm run test:run should pass.
  • Write documentation using styleguidist and build it using npm run styleguide:build.
  • Run npm run build to generate the library.
  • Commit all the changes and either merge to develop or send a pull request.