HospitalRun Frontend

React frontend for HospitalRun: free software for developing world hospitals.

Version 1.0.0-beta is no longer supported. Version 2 is currently under development.

To contribute, follow the guidelines in the readme or alternatively ask for details on Slack channel #contributors.
To use version 1.0.0-beta (not production ready) in a hospital facility, ask for support on Slack channel #troubleshooting.

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 hospitalrun-frontend
Install the dependencies: yarn
Run yarn run start to build and watch for code changes

Connecting to HospitalRun Server

Note: The following instructions are for connecting to HospitalRun Server during development and are not intended to be for production use. For production deployments, see the deployment instructions.

Configure HospitalRun Server
Start the HospitalRun Development Server
Copy the .env.example file to .env
Change the REACT_APP_HOSPITALRUN_API variable to point to the HospitalRun Development Server.

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 mandatory for making proper commits. Once you have staged your changes, can run npm run commit or yarn commit from the root directory in order to commit following our standards.