{"id":13493959,"url":"https://github.com/HospitalRun/hospitalrun-server","last_synced_at":"2025-03-28T13:31:28.554Z","repository":{"id":15634408,"uuid":"18371322","full_name":"HospitalRun/hospitalrun-server","owner":"HospitalRun","description":"Backend for HospitalRun","archived":true,"fork":false,"pushed_at":"2023-01-09T09:53:11.000Z","size":1640,"stargazers_count":875,"open_issues_count":12,"forks_count":641,"subscribers_count":63,"default_branch":"master","last_synced_at":"2024-10-30T00:55:15.525Z","etag":null,"topics":["backend","fastify","hospitalrun","hospitalrun-server","nodejs"],"latest_commit_sha":null,"homepage":"https://hospitalrun.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HospitalRun.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null},"funding":{"github":null,"patreon":null,"open_collective":"hospitalrun","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2014-04-02T15:29:37.000Z","updated_at":"2024-10-22T21:13:13.000Z","dependencies_parsed_at":"2023-01-11T19:09:48.521Z","dependency_job_id":null,"html_url":"https://github.com/HospitalRun/hospitalrun-server","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HospitalRun%2Fhospitalrun-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HospitalRun%2Fhospitalrun-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HospitalRun%2Fhospitalrun-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HospitalRun%2Fhospitalrun-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HospitalRun","download_url":"https://codeload.github.com/HospitalRun/hospitalrun-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246037344,"owners_count":20713398,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","fastify","hospitalrun","hospitalrun-server","nodejs"],"created_at":"2024-07-31T19:01:20.363Z","updated_at":"2025-03-28T13:31:28.172Z","avatar_url":"https://github.com/HospitalRun.png","language":"JavaScript","funding_links":["https://opencollective.com/hospitalrun"],"categories":["JavaScript"],"sub_categories":[],"readme":"# HospitalRun Server\n\n\u003cdiv align=\"center\"\u003e\n\n![Status](https://img.shields.io/badge/Status-developing-brightgree) [![Release](https://img.shields.io/github/release/HospitalRun/hospitalrun-server.svg)](https://github.com/HospitalRun/hospitalrun-server/releases) [![Version](https://img.shields.io/github/package-json/v/hospitalrun/hospitalrun-server)](https://github.com/HospitalRun/hospitalrun-server/releases) [![GitHub CI](https://github.com/HospitalRun/server/workflows/GitHub%20CI/badge.svg)](https://github.com/HospitalRun/server/actions) [![Coverage Status](https://coveralls.io/repos/github/HospitalRun/hospitalrun-server/badge.svg?branch=master)](https://coveralls.io/github/HospitalRun/hospitalrun-server?branch=master) [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/HospitalRun/hospitalrun-server.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/HospitalRun/hospitalrun-server/context:javascript) ![Code scanning](https://github.com/HospitalRun/hospitalrun-server/workflows/Code%20scanning/badge.svg?branch=master) [![Documentation Status](https://readthedocs.org/projects/hospitalrun-server/badge/?version=latest)](https://hospitalrun-server.readthedocs.io)\n [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FHospitalRun%2Fhospitalrun-server.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FHospitalRun%2Fhospitalrun-server?ref=badge_shield) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) ![dependabot](https://api.dependabot.com/badges/status?host=github\u0026repo=HospitalRun/hospitalrun-server) [![Slack](https://hospitalrun-slack.herokuapp.com/badge.svg)](https://hospitalrun-slack.herokuapp.com)\n\n\u003c/div\u003e\n\nNode.js backend for [HospitalRun](http://hospitalrun.io/): 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](https://hospitalrun-slack.herokuapp.com).\n\n---\n\n**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](https://github.com/HospitalRun/hospitalrun-server/tree/1.0.0-beta).**\n\n# Contributing\n\nContributions are always welcome. Before contributing please read our [contributor guide](https://github.com/HospitalRun/hospitalrun-server/blob/master/.github/CONTRIBUTING.md). Then follow these steps:\n\n1. [Fork](https://github.com/HospitalRun/hospitalrun-server/fork) this repository to your own GitHub account\n2. Clone it to your local machine\n3. Navigate to the cloned folder: `cd hospitalrun-server`\n4. Install the dependencies: `npm install`\n5. Check that [env variables](https://github.com/HospitalRun/hospitalrun-server#environment) are set correctly \n6. Run `npm run dev` to build and watch for code changes:\n   - a development database will start on http://localhost:5984\n   - you can access its Admin interface on http://localhost:5984/_utils, `username: dev` and `password: dev`\n\n## Working on Issues\nIn 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.\n\n## Environment\nIn order to run `hospitalrun-server`  you need to set the correct environment variables. Since [dotenv](https://www.npmjs.com/package/dotenv) is already included, it is just matter of renaming `.env.example` file to `.env`: this file include all of the mandatory defaults.\n\n## Development Database\nThis project uses [pouchdb-server](https://www.npmjs.com/package/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.\n\n**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.**\n\n## Tests\nEvery code additions or fixs on the existing code, has to be tested. This project uses [node-tap](https://node-tap.org/) as test runner. To run all tests use `npm run test`.\n\n## How to commit\n\nThis repo uses [Conventional Commits](https://www.conventionalcommits.org/). [Commitizen](https://github.com/commitizen/cz-cli) 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.\n\n# Documentation\n## DataBase\nRead more at \u003ca href=\"https://github.com/HospitalRun/hospitalrun-server/blob/master/docs/database.md\"\u003e\u003ccode\u003e\u003cb\u003eHospitalRun DataBase\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e.\n\n## Plugins\nRead more at \u003ca href=\"https://github.com/HospitalRun/hospitalrun-server/blob/master/docs/plugins.md\"\u003e\u003ccode\u003e\u003cb\u003eHospitalRun Plugins\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e.\n\n## Services\nRead more at \u003ca href=\"https://github.com/HospitalRun/hospitalrun-server/blob/master/docs/services.md\"\u003e\u003ccode\u003e\u003cb\u003eHospitalRun Services\u003c/b\u003e\u003c/code\u003e\u003c/a\u003e.\n\n# License\n\nReleased under the [MIT license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHospitalRun%2Fhospitalrun-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FHospitalRun%2Fhospitalrun-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FHospitalRun%2Fhospitalrun-server/lists"}