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.
- Fork this repository to your own GitHub account and then clone it to your local device
- Navigate to the cloned folder:
cd components
- Install the dependencies:
npm install
- Run
npm link
to link the local repo to the global npm folder - Run
npm run dev
to build and watch for code changes - In another terminal window create a new react project with
npx create-react-app my-app
- 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 - Link the components repo inside your newly created react project with
npm link components
- 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
Big Thanks
Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs
Backers
Lead Maintainer
Maksim Sinik
Core Team
Medical Supervisor
M.D. Daniele Piccolo
Contributors
Founders
License
Released under the MIT license.