From 6b808f2e203bfed3f48b288ca406723b257df067 Mon Sep 17 00:00:00 2001
From: Aurthur Musendame <musendamea@nmrl.org.zw>
Date: Sun, 1 Sep 2024 19:22:05 +0200
Subject: [PATCH] updated read me with extra servoces

---
 .idea/workspace.xml |  9 ---------
 README.md           | 39 ++++++++++++++++++++++++---------------
 2 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index d3cba1e1..944e3412 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -6,16 +6,7 @@
   <component name="ChangeListManager">
     <list default="true" id="9f590b69-f929-45a1-8512-12ed6efbf028" name="Changes" comment="Added Invetory starter">
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Dockerfile.dev" beforeDir="false" afterPath="$PROJECT_DIR$/Dockerfile.dev" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Dockerfile.prod" beforeDir="false" afterPath="$PROJECT_DIR$/Dockerfile.prod" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/caddy.data/caddy/last_clean.json" beforeDir="false" afterPath="$PROJECT_DIR$/caddy.data/caddy/last_clean.json" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/caddy.data/caddy/pki/authorities/local/intermediate.crt" beforeDir="false" afterPath="$PROJECT_DIR$/caddy.data/caddy/pki/authorities/local/intermediate.crt" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/caddy.data/caddy/pki/authorities/local/intermediate.key" beforeDir="false" afterPath="$PROJECT_DIR$/caddy.data/caddy/pki/authorities/local/intermediate.key" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/docker-compose.dev.yml" beforeDir="false" afterPath="$PROJECT_DIR$/docker-compose.dev.yml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/docker-compose.prod.yml" beforeDir="false" afterPath="$PROJECT_DIR$/docker-compose.prod.yml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/felicity/apps/abstract/events.py" beforeDir="false" afterPath="$PROJECT_DIR$/felicity/apps/abstract/events.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/felicity/core/config.py" beforeDir="false" afterPath="$PROJECT_DIR$/felicity/core/config.py" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
diff --git a/README.md b/README.md
index 3875fc1c..a39d1fe3 100644
--- a/README.md
+++ b/README.md
@@ -19,30 +19,39 @@ Felicity is the quality of being good, pleasant, or desirable.
 
 ### FrontEnd
 
-Felicity's fr17d2a812831aontend is developed using Vite, Vue, URQL, and Tailwind CS, etc.
+Felicity's frontend is developed using Vite, Vue, URQL, and Tailwind CS, etc.
 
 ### Backend
 
 Felicity's backend is developed using FastAPI, Strawberry-Graphql and SQLAlchemy
 
+Minio is used as object storage to store pdf reports
+
+Mongodb is used to store audit logs
+
+Postgres is the main db with core tables
+
+Dragonfly is the redis cache to keep track of sample status locks, websocket subscriptions etc
+
 ## Main Features
 
 - Dashboard - Analytics
 - Patient - Listing, compact, detail, search, Audit Log
 - Sample - Listing, Detail, Audit Log, Reports, search
 - Worksheet - Templates, listing, auto create, multi create, manual create
-- Inventory - Item manager, listing, detail, transactios, adjustments, orders, requests
+- Inventory - Item manager, listing, detail, transactions, adjustments, orders, requests
 - Shipment - Fhir ready (experimental), Listing, detail,
 - Storage - store rooms, locations, containers, templates,
 - Client - listing, detail, contacts
 - User - listing, profiles, RBAC
-- Billing - listing, profiles, RBAC
+- Billing - listing, profiles, RBAC -- incomplete
 - Admin - admin functions
+- Reflex rules
 
 ## Installation
 
 Our recommended method to get up and running quickly is to use the docker.
-This method uses Docker and docker-compose which handles the details of installing dependencies for you.
+This method uses Docker and docker compose which handles the details of installing dependencies for you.
 
 We provide 2 methods to run felicity with docker. Choose whichever methods suits you best.
 
@@ -53,29 +62,29 @@ cd felicity-lims
 
 ##### Method 1. FastAPI serve static files generated by the vue frontend.
 
-Docker service presets are: *felicity_aio_caddy*, *felicity_aio_nginx*, *felicity_aio*
+Docker service presets are: *felicity-aio-caddy*, *felicity-aio-nginx*, *felicity-aio*
 
-- **felicity_aio_caddy** - felicity serves static files with caddy as a reverse proxy in front
-- **felicity_aio_nginx** - felicity serves static files with nginx as a reverse proxy in front
-- **felicity_aio** - felicity serves static files without a reverse proxy
+- **felicity-aio-caddy** - felicity serves static files with caddy as a reverse proxy in front
+- **felicity-aio-nginx** - felicity serves static files with nginx as a reverse proxy in front
+- **felicity-aio** - felicity serves static files without a reverse proxy
 
 ```commandline
 docker compose -f ./docker-compose.prod.yml up -d your_preset --build
-docker-compose -f docker-compose.prod.yml exec your_preset bash -c "cd felicity && alembic upgrade head"
-docker-compose -f docker-compose.prod.yml logs your_preset -f -n100
+docker compose -f docker-compose.prod.yml exec your_preset bash -c "cd felicity && alembic upgrade head"
+docker compose -f docker-compose.prod.yml logs your_preset -f -n100
 ```
 
 ##### Method 2. Nginx/Caddy serve static files generated by the vue frontend.
 
-Docker service presets are: *felicity_static_nginx*, *felicity_static_caddy*
+Docker service presets are: *felicity-static-nginx*, *felicity-static-caddy*
 
-- **felicity_static_nginx** - felicity handles the api and nginx serves static files
-- **felicity_static_caddy** - felicity handles the api and caddy serves static files
+- **felicity-static-nginx** - felicity handles the api and nginx serves static files
+- **felicity-static-caddy** - felicity handles the api and caddy serves static files
 
 ```commandline
 docker compose -f ./docker-compose.prod.yml up -d your_preset --build
-docker-compose -f docker-compose.prod.yml exec your_preset bash -c "cd felicity && alembic upgrade head"
-docker-compose -f docker-compose.prod.yml logs your_preset -f -n100
+docker compose -f docker-compose.prod.yml exec your_preset bash -c "cd felicity && alembic upgrade head"
+docker compose -f docker-compose.prod.yml logs your_preset -f -n100
 ```
 
 ##### Alternative deployment method without docker