Merge pull request #61 from Haiti-Distributed-Healthcare-System/readme-lighthouse

Update Readme + Remove Lighthouse

.github/workflows/lighthouse.yml

@@ -1,25 +0,0 @@
-name: Build project and Run Lighthouse CI
-on: [push]
-jobs:
-  lhci:
-    name: Lighthouse CI
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - name: Use Node.js 10.x
-        uses: actions/setup-node@v1
-        with:
-          node-version: 10.x
-      - name: npm install, build
-        run: |
-          pushd pwa && npm install
-          npm run build && popd
-      - name: run Lighthouse CI
-        run: |
-          npm install -g @lhci/cli@0.3.x
-          lhci autorun || echo "LHCI failed!"
-      - name: Upload lighthouse report
-        uses: actions/upload-artifact@v1
-        with:
-          name: lighthouse
-          path: ./.lighthouseci

.github/workflows/pwa-tests.yml

@@ -19,6 +19,7 @@ jobs:
       - run: docker-compose -f dev-docker-compose.yml up --detach
       - run: docker exec haiti_pwa npm run test:cov
       - run: docker exec haiti_pwa npm run cy:run
+      - run: docker exec haiti_pwa npm run build
       - run: docker-compose -f dev-docker-compose.yml down
         env:
           CI: true

.lighthouserc.json

@@ -1,11 +0,0 @@
-{
-  "ci": {
-    "collect": {
-      "staticDistDir": "./pwa/build",
-      "numberOfRuns": 3
-    },
-    "upload": {
-      "target": "temporary-public-storage"
-    }
-  }
-}

README.md

@@ -13,7 +13,7 @@
 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 -f dev-docker-compose.yml up` from the root directory.
-  - `docker-compose -f dev-docker-compose.yml up` will then stop the docker processes from running in the background.
+- The PWA, API, Database, and Swagger documentation can be started by running the command `docker-compose -f dev-docker-compose.yml up` from the root directory.
+  - `docker-compose -f dev-docker-compose.yml 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 [dev-docker-compose.yml](https://github.com/Haiti-Distributed-Healthcare-System/hdhs/blob/dev/dev-docker-compose.yml).
 - More tips to troubleshoot docker are available [here](https://github.com/Haiti-Distributed-Healthcare-System/hdhs/wiki/Using-Docker).