HospitalRun Server
Node.js backend for HospitalRun: free software for developing world hospitals. To contribute, follow the guidelines in this readme or alternatively ask for details on the community Slack channel: #contributors.
This repository is for the HospitalRun v2 and it is currently under heavy development. If you are searching for the no longer supported version 1.0.0-beta, you can find it here.
Contributing
Contributions are always welcome. Before contributing please read our contributor guide. Then follow these steps:
- Fork this repository to your own GitHub account
- Clone it to your local machine
- Navigate to the cloned folder:
cd hospitalrun-server
- Install the dependencies:
npm install
oryarn install
- Run
npm run dev
oryarn dev
to build and watch for code changes:- a development database will start on http://localhost:5984
- you can access its Admin interface on http://localhost:5984/_utils,
username: dev
andpassword: dev
Working on Issues
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.
Environment
In order to run hospitalrun-server
you need to set the correct environment variables. Since dotenv is already included, it is just matter of renaming .env.example
file to .env
: this file include all of the mandatory defaults.
Development Database
This project uses pouchdb-server for development and you, as contributor, don't need to provide your own CouchDB instance. Upon first run of the dev
script (npm run dev
or yarn dev
), a new data
folder will be created inside the ./db
folder. The database credentials are: username: dev
and password: dev
. The file ./db/config.json
contains the DB's configuration: you can change it if you want, but please don't commit any changes to it.
Note: PouchDB-server is meant to be use only during development. Please don't deploy any production/testing HospitalRun instances on it. For production deployments please follow the deployment guide.
Tests
Every code additions or fixs on the existing code, has to be tested. This project uses node-tap as test runner. To run all tests use npm run test
or yarn test
.
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.
Documentation
DataBase
Read more at HospitalRun DataBase
.
Plugins
Read more at HospitalRun Plugins
.
Services
Read more at HospitalRun Services
.
Behind HospitalRun
Hosted by
Sponsors
Backers
Lead Maintainer
Core Team
Stefano Casasola |
Michael Daly |
Riccardo Gulin |
Grace Lau |
Jack Meyer |
Matteo Vivona |
---|
Medical Supervisor
Contributors
Founders
John Kleinschmidtr |
Joel Worrall |
Joel Glovier |
---|
License
Released under the MIT license.