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.
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 - Check that env variables are set correctly
- Run
npm run devto 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: devandpassword: dev
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.
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.
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), 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.
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.
This repo uses Conventional Commits. Commitizen is mandatory for making proper commits. Once you have staged your changes, can run npm run commit from the root directory in order to commit following our standards.
Read more at HospitalRun DataBase.
Read more at HospitalRun Plugins.
Read more at HospitalRun Services.
Released under the MIT license.