Offline-First, Educational Patient Management for Optometrists
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
SuperVision is a patient management system for optometry clinics. It has been designed to be used by the Aotearoa Vision Bus.
Since the application will be used in situations with minimal or no data connection, it has been designed to be functional without an internet connection and to minimise the bandwidth necessary to run it, while still synchronising in real-time with other clients.
- Offline first functionality
- Fast realtime synchronisation
- Low bandwidth usage
- Patient Management
- Record Consultations
- Record Dispensed Spectacles
Detailed documentation and C4 diagrams are available here.
To get a local copy up and running follow these simple example steps.
https://nodejs.org/en/download/
Ubuntu
# Install PostgreSQL
sudo apt update
sudo apt install postgresql postgresql-contrib
# Create a User
sudo -u postgres createuser --interactive --pwprompt
# Create database
sudo -u postgres createdb supervision
Windows (chocolatey)
https://chocolatey.org/# Install PostgreSQL
> choco install postgresql --params '/Password:<YOUR_SUPERUSER_PASS>'
# IMPORTANT: Restart all active terminal/bash/cmd/ps sessions
# Create a User
> createuser -U postgres --interactive --pwprompt
> Enter name of role to add: <windows username>
> Enter password for new role: <a password>
> Enter it again: <a password, again>
> Shall the new role be a superuser? (y/n) n
> Shall the new role be allowed to create databases? (y/n) y
> Shall the new role be allowed to create more new roles? (y/n) n
> Password: <YOUR_SUPERUSER_PASS>
# Create the database
> createdb supervision
> Password: <the password for the role you just created>
- Get an API Key at https://auth0.com
- Sign up or login to access the dashboard
- Click Create Application
- Choose "Single Page Web Application"
- Take note of the Client ID and Client Secret
- Repeat the process but choosing the "Machine to Machine" application type.
- Authorise this application for the Auth0 Management API
- Clone the repo
git clone https://github.com/University-of-Auckland-SOFTENG761/project-team-1 supervision
- Install NPM packages
cd supervision npm install
- Setup backend configuration
Fill out the
cp apps/backend/.env.template apps/backend/.env
.env
file with the details of your postgresql and auth0 configurations. - Modify frontend configuration files as necessary
- Run backend
nx serve backend
- Run frontend (in a separate terminal)
nx serve frontend
This project was created as part of a university course and is no longer actively maintained.
- Veeran Morar, for being an excellent PO