HospitalRun Components

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

Install

Install components:

npm install @hospitalrun/components

Install react-bootstrap:

npm install react-bootstrap

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

npm install -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: npm install
4. Run npm link to link the local repo to the global npm folder
5. Run npm run dev to build and watch for code changes
6. In another terminal window create a new react project with npx create-react-app my-app‌
7. Navigate (cd my-app) to your react project and install node-sass: npm install -D node-sass. Components styles are coded using scss and you need this dependency in order to successfully import components' .scss files
8. Link the components repo inside your newly created react project with npm link components
9. Start your react project with npm start and enjoy hot reloading when applying changes in the components repo

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 J Feher | Riccardo Gulin | Jack Meyer | Matteo Vivona | |---|---|---|---|---|

Medical Supervisor

M.D. Daniele Piccolo

Contributors

Founders

| John Kleinschmidtr | Joel Worrall | Joel Glovier | |---|---|---|

License

Released under the MIT license.