Skip to content
Backend for HospitalRun
TypeScript JavaScript
Branch: master
Clone or download

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore(stale): update days of inactivity May 2, 2020
.vscode feat: add couchcb basic routes Feb 7, 2020
bin fix: fix ddoc build command on empty src folder Mar 4, 2020
db feat: add couchcb basic routes Feb 7, 2020
docs docs: update database docs Mar 4, 2020
src build(deps-dev): bump prettier from 1.19.1 to 2.0.2 (#266) May 17, 2020
test fix: fix test environment Feb 7, 2020
typings ♻️ (configuration) Refactors project toolchain configuration Sep 10, 2019
.editorconfig ♻️ (configuration) Refactors project toolchain configuration Sep 10, 2019
.env.example feat: add couchcb basic routes Feb 7, 2020
.eslintrc.js fix(eslintrc): remove createDefaultProgram Mar 6, 2020
.gitignore fix: add better error handling on ddoc bin Mar 4, 2020
.gitpod.yml ci(gitpod): updates config Apr 24, 2020
.npmrc fix: adds .npmrc Sep 27, 2019
.prettierrc fix: add prettier eol to the config Feb 17, 2020
CHANGELOG.md chore(release): 2.0.0-alpha.2 May 17, 2020
LICENSE fix(license): reverts license to MIT on the next version Sep 27, 2019
README.md docs(readme): fix badge May 17, 2020
commitlint.config.js build: removes gitmoji Sep 18, 2019
mkdocs.yml Update mkdocs.yml Feb 8, 2020
package.json build(deps-dev): bump @types/node from 13.13.9 to 14.0.5 (#313) May 22, 2020
tsconfig.json feat: implement design documents context namespace Mar 3, 2020

README.md

HospitalRun Server

Status Release Version GitHub CI Coverage Status Language grade: JavaScript Documentation Status FOSSA Status Commitizen friendly dependabot Slack

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:

  1. Fork this repository to your own GitHub account
  2. Clone it to your local machine
  3. Navigate to the cloned folder: cd hospitalrun-server
  4. Install the dependencies: npm install or yarn install
  5. Run npm run dev or yarn dev to build and watch for code changes:

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

Sponsors

Backers

Backers

Lead Maintainer


Maksim Sinik

Core Team


Stefano Casasola

Michael Daly

Riccardo Gulin

Grace Lau

Jack Meyer

Matteo Vivona

Medical Supervisor


M.D. Daniele Piccolo

Contributors

Contributors

Founders


John Kleinschmidtr

Joel Worrall

Joel Glovier

License

Released under the MIT license.

You can’t perform that action at this time.