Client Overview
Major pieces of the overall system:
The major pieces of application are describe in our architechture diagram which you can find bellow. Generally speaking, our application is hosted in Heroku which is a cloud base hosting service that allows you to host applications. Currently there are 2 applications hosted in Heroku. The first deals with our application user interface meaning the frontend of the project or what the user actually sees and interacts with in the screen. For this frist application our development team used ReactJS a JavaScript library that allows you to create component base user interfaces. The second is a Flask Python application which is basically in charge of servicing the fronted application or user interface. For the project's database we are using MongoDB which is a no relational database which allows you to create collections to store the information resulting from the user interaction with the app. For more specific information click the image of the Architecture diagram bellow.
Application Architecture Diagram
Deployment:
The frontend application is hosted in Heroku and its set to continuos deployment from github which is where the application code lives. Github is a web application that allows developers to save their code and also collaborate in repositories simultaneously. Continuos deployment means that every time any of the projects developers pushes or save code to github a deployment will be trigger in Heroku. The backend application is also hosted in Heroku and is also set for continuos deployment and the code for this application also lives in Github. As per the project database is hosted in an MongoDB Atlas cluster (Refer diagram architechture for more information).
Project cost:
Currently the cost for the application services is zero but this may change as the projects needs change and also the size of the data managed by the application increases. For more information visit the pages bellow:
Heroku Pricing: https://www.heroku.com/pricing
MongoDB Atlas Pricing: https://www.mongodb.com/pricing
Where is the code:
The code currently lives on Github. There are 2 main repos for the application one that has the frontend code and the other has the backend code. Main Project Repo: Slidedeck. All the code for our app is free to use and MIT Lisence for more information check the developer readme on Github.
Accessing the app:
The app is currently available at: https://slidedeck-fe.herokuapp.com/
User accessibility:
The app is only available for the users registered in the application system. In order to register to the app the user first most receive an invitation code and link from the project administrator. Since the app is used in a medical lab unwanted users cannot be able to access the app.
What is next:
As a next step it would be great to setup a domain for the application, that way it would be more intuitive for the users using the app to access the application. More importanly after the semester ends if all the needs to have features are not finished we recommend completing these features since they are the bare minimun the UNC pathologist lab needs to work. After it will be a good idea to tackle the nice to have features. We trully recommend a second round of COMP523 since they can get the advantage of free developers.
Need to have features progress:
- As an authenticated doctor, in order to validate a test, I can digitally sign a form. Done
- In order to document failures or irregularities, I can add notes to a form or mark it as failed. In Progess
- As an authenticated doctor, in order to facilitate a timely response, I can receive emails or other notifications when a form is ready for me to review. In Progress
- As an authenticated doctor, in order to respond to my forms, I can see the pending forms that I have not signed off on. Done
- As an authenticated user, in order to comply with inspections, I can view forms and access backups of forms. In Progress
- As an authenticated technician, in order to track tissue stains, I can use the webform to enter the information in an easy and intuitive way. Done
- As an authenticated technician, in order to verify results with pathologists, I can use the dashboard to see forms I’ve worked on and forms that need my attention. Done
- As an authenticated technician, in order to have the tests confirmed, I can submit a form for a doctor to review. Done
- As a logged-out user, in order to start using the app, I can register a new account. Done
- In order to update form templates, I can use my dashboard to manage forms and even create new forms. In Progress
- In order to get a hard copy of the form results, I can export form data into a spreadsheet or PDF for printing. In Progress
Nice to have features progress:
- As an authenticated user, in order to personalize what the app shows me, I can change my account settings to assume different roles (technician, pathologist, admin, etc...). In Progress
- As an authenticated user, in order to find forms quickly, I can search the records of past forms. In Progress
- As an authenticated user, in order to help gather information, I can see which lab tech submitted the form. In Progress
- As an authenticated admin user, in order to confirm who people are, I can assign users roles. In Progress
- As an authenticated user, in order to review past forms, I can sort forms by different categories. In Progress
- As an authenticated user, in order to find the corresponding form, I can scan the existing QR code on the slide. In Progress