SBCQ-132 Updating Documentation 3/13

README.md

@@ -1,5 +1,5 @@
 [![img](https://img.shields.io/badge/Lifecycle-Stable-97ca00)]
-## Queue Managment System
+## Queue Managment System - About
 
 The Queue Managment System will be used to manage the citizen flow and provide analtyics for our Service BC locations. This system is designed to be used for government offices with a large number of services.
 
@@ -11,9 +11,9 @@ Designed for use in an application platform buld for containers specifically Ope
 
 - VueJS & BootStrap for Front End
 - Flask & Python for API Backend
-- Patroni Database Cluster
-- RabbitMQ
-- Caddy HTTP/2 Web Server
+- EDB (Postgres)
+- Redis
+- Ngnix
 
 ## Features
 

appointment-frontend/README.md

@@ -15,7 +15,7 @@ cd api
 mkdir client_secrets
 cd ..
 
-cp documentation/demo-files/secrets.json api/client_secrets/secrets.json
+cp -r .devcontainer/config/api/client_secrets  api/
 ```
 
 Note: 

documentation/Readme.md

@@ -1,15 +1,16 @@
-# Installation Guide - Work in Progress
+# Queue-Management : Installation Guide 
 
 We use OpenShift in our environment, and it is our recommendation for running this project. You can then use our build / deployment configs found in the openshift directory.
 
 For development, we recommend you use Visual Studio Code's *Remote - Containers* to run the application in docker containers, as described below.
 
 ## Key features of the platform:
 
-Jenkins Build process includes:
+Git Actions Build process includes:
 
 - Building our Flask/Python API
-- Building our Vue FrontEnd and copying the output to CADDY Webserver
+- Building our Vue FrontEnd
+- Cypress e2e Tests
 - Postman tests
 - Zap Vulnerability tests
 
@@ -79,18 +80,7 @@ queue-management
     └───notifications-api
             .env
 ```
-
-## Set up Keycloak:
-
-TODO: automate this.
-
-You should be able to login in with admin/admin on http://localhost:8085/auth
-1. Go to Groups, add new group *theq_internal_user*
-1. Go to Roles, add new role *internal_user*
-1. Go to Users, view all users, edit 'admin', 
-    - under Groups, under Available Groups, join *theq_internal_user*
-    - under Role Mappings, select *internal_user*, add selected, should see under assigned role
-1. Go to Clients, edit *account*, Scope tab, set Full Scope Allowed to ON
+NOTE: get .env files from Teams Channel : "DevOps - Openshift"
 
 ## Frequently Asked Questions
 
@@ -208,13 +198,6 @@ It's probably a good idea to delete your database volume when changing the versi
 </details>
 
 
-# TODO: REMOVE/REVISE/INCLUDE EVERYTHING BELOW
-
-**TODO: Complete these: How do I...**
-
-1. Do stuff with analytics?
-1. Run Redis?
-
 ## To use FRONTEND:
 
 **IMPORTANT: To login, use the Keycloak Login link at the bottom right hand corner. The main login is used with Single Signon integration to our Enterprise Active Directory Domain.**