README.md

HospitalRun Components

This repository will host reusable react components made for the HospitalRun frontend.

---

Install

Install components:

yarn add @hospitalrun/components

Install react-bootstrap:

yarn add react-bootstrap

[Optional] You may need node-sass if you want to import components' .scss files:

yarn add -D node-sass

Contributing

Contributions are always welcome. Before contributing please read our contributor guide.

1. Fork this repository to your own GitHub account and then clone it to your local device
2. Navigate to the cloned folder: cd components
3. Install the dependencies: yarn
4. Run yarn dev to build and watch for code changes
5. In another window, run storybook yarn storybook. Story book should open in a your default browser at localhost:6006.
6. You will be able to test components with storybook and enjoy live reloading!

Working on an Issue

In order to optimize the workflow and to prevent multiple contributors working on the same issue without interactions, a contributor must ask to be assigned to an issue by one of the core team members: it's enough to ask it inside the specific issue.

How to commit

This repo uses Conventional Commits. Commitizen is recommended for development. Once you have changes staged you can run git cz from the root directory in order to commit to the proper standards.

Alternatively, if you are using NPM 5.2+ you can use npx instead of installing globally: npx git-cz

---

Behind HospitalRun

Hosted by

Sponsors

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

Backers

Lead Maintainer

_{Maksim Sinik}

Core Team

Stefano Casasola	Michael Daly	Riccardo Gulin	Grace Lau	Jack Meyer	Matteo Vivona

Medical Supervisor

_{M.D. Daniele Piccolo}

Contributors

Founders

John Kleinschmidtr	Joel Worrall	Joel Glovier

License

Released under the MIT license.