From 0d9d87ecf153093df5cda9be80e7f0b02aa504df Mon Sep 17 00:00:00 2001 From: Ben Mitchinson Date: Mon, 17 Feb 2020 08:33:05 -0600 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dc72f36..22d218b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ -# hdhs -Haiti Distributed Healthcare System +

+ +

Haiti Community Health Initiative Application

+

+

+ A containerized progressive web application paired with patient data management tooling built to serve the Haiti Community Health Initiative in their mission to help form healthy and self-directed communities in Haiti. +

+ +--- + +## Getting Started + +The application runs on docker, which can be installed [here](https://docs.docker.com/install/). +If you're a linux user, you'll also need to install [docker-compose](https://docs.docker.com/compose/install/) separately. Otherwise, it's included in the Mac and PC versions of "Docker Desktop" + +- The PWA and accompanying database can be started by running the command `docker-compose up` from the root directory. + - `docker-compose down` will then stop the docker processes from running in the background. +- Once the images have been built and the processes started, the PWA can be seen at your localhost, at the port specified in [docker-compose.yml](https://github.com/Haiti-Distributed-Healthcare-System/hdhs/blob/dev/docker-compose.yml). +- More tips to troubleshoot docker are available [here](https://github.com/Haiti-Distributed-Healthcare-System/hdhs/wiki/Using-Docker).