aboutsummaryrefslogtreecommitdiff
path: root/docs/DesignDoc.md
diff options
context:
space:
mode:
authorGunther6070 <haydenhartman10@yahoo.com>2025-03-17 17:10:24 -0400
committerGunther6070 <haydenhartman10@yahoo.com>2025-03-17 17:10:24 -0400
commitb998a4e7ca580f19ab10862de61d7458031027f2 (patch)
treeae5919c8d0ca1dde71ea11914541a87b456ebfc9 /docs/DesignDoc.md
parent9baaa0590fbc38c06d530786a1de804ee9edd7db (diff)
downloadJellySolutions-b998a4e7ca580f19ab10862de61d7458031027f2.tar.gz
JellySolutions-b998a4e7ca580f19ab10862de61d7458031027f2.tar.bz2
JellySolutions-b998a4e7ca580f19ab10862de61d7458031027f2.zip
Filled out some of the sprint 2 sections
Diffstat (limited to 'docs/DesignDoc.md')
-rw-r--r--docs/DesignDoc.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/DesignDoc.md b/docs/DesignDoc.md
index 80d3778..5fda309 100644
--- a/docs/DesignDoc.md
+++ b/docs/DesignDoc.md
@@ -23,9 +23,9 @@ Our project is intended to create a space to fund aquatic conservation, from phy
### Glossary and Acronyms
> _**[Sprint 2 & 4]** Provide a table of terms and acronyms._
-| Term | Definition |
-|------|------------|
-| SPA | Single Page |
+| Term | Definition |
+|------|-------------|
+| SPA | Single Page |
## Requirements
@@ -38,6 +38,7 @@ This section describes the features of the application.
### Definition of MVP
> _**[Sprint 2 & 4]** Provide a simple description of the Minimum Viable Product._
+Users are able to login to the Ufund, either as a manager or helper. Helpers are able to go to the cupboard and can view needs, search for needs, add/remove needs to their funding basket, and check out and fund needs. Managers can add, remove, and edit needs in the cupboard. Needs are saved so users and managers will see when they are updated.
### MVP Features
> _**[Sprint 4]** Provide a list of top-level Epics and/or Stories of the MVP._
@@ -50,12 +51,13 @@ This section describes the features of the application.
This section describes the application domain.
-![Domain Model](domain-model-placeholder.png)
+![Domain Model](domain-model.png)
> _**[Sprint 2 & 4]** Provide a high-level overview of the domain for this application. You
> can discuss the more important domain entities and their relationship
> to each other._
+Each user views 1 cupboard which can contain 0 or more needs. They can take 1 or more needs and put them in their funding basket which they can then check out. 1 or more managers will manaager the 1 cupboard, add, removing, and editing needs within it.
## Architecture and Design
@@ -130,7 +132,7 @@ The Model Tier contains the classes responsible for handling and serving Need da
> _At appropriate places as part of this narrative provide **one** or more updated and **properly labeled**
> static models (UML class diagrams) with some details such as associations (connections) between classes, and critical attributes and methods. (**Be sure** to revisit the Static **UML Review Sheet** to ensure your class diagrams are using correct format and syntax.)_
>
-![Replace with your Model Tier class diagram 1, etc.](model-placeholder.png)
+![Replace with your Model Tier class diagram 1, etc.](u-fund.drawio.png)
## OO Design Principles
@@ -157,6 +159,8 @@ The Model Tier contains the classes responsible for handling and serving Need da
> _This section will provide information about the testing performed
> and the results of the testing._
+Currently around 100 tests, with roughly 95% coverage overall. Model tier is above 95% individually.
+
### Acceptance Testing
> _**[Sprint 2 & 4]** Report on the number of user stories that have passed all their
> acceptance criteria tests, the number that have some acceptance