Package View - SENG-350-2024-fall/Team-8 GitHub Wiki
Package View
Primary Presentation
Front End Package
The Front End Package encapsulates everything which makes up the interface that users interact on the Mister Ed web app.
Element Name | Description |
---|---|
Pages | The webpages themselves, created using react. |
States | Store important information of the user's session in the browser (logged in, account type). |
API Clients | Communicate with the back end to submit and retrieve information. |
Components | Shared elements and libraries used on all pages for functionality of the app (react router, material ui, navigate, etc). |
Back End Package
The Back End Package is the behind the scenes engine that controls the creation, storage, retrieval, and modification of data relevant to the system. It is by and large the JSON server.
Element Name | Description |
---|---|
JSON Server | The back end which stores all of the Mister ED data. The db.json stores all user and triage information, while logs.json stores all the logger information generated during a user session for availability tactic purposes. |
Data Layer Package
The Data Layer Package is a further abstraction of how the data within the JSON Server backend is represented in the system. The back end package is dependent on this abstraction and the data it contains.
Element Name | Description |
---|---|
Users | This covers all of the different types of users in the system, created by a common user factory pattern. Each has its own set of permissions and data values, and each is grouped by type. |
Notifications | Dispatch requests and appointments. These objects exist separate from the other object types, but share similar behaviour in being generated during triage and notifying a third party user, the EMTs and Doctors, respectively. |
Queue | Holds the generated triage objects until they are dequeued and processed by a nurse. Dynamically grows and shrinks as triage objects are created and processed by patients and nurses. |
Variability Guide
The notification and triage queue objects are not yet finalized, so their representation in this view is subject to change.
Other Information
This view is a high level overview designed to convey the logical separation of the major components of the Mister Ed system on a macro level, so some granularity is lost in things like individual pages, API clients, database objects etc. It can be drilled down further by analyzing some of the other views.
Related Views
- Relation (Parent, Refinement, Common elements, etc). Name of view and a link to it.