diff options
Diffstat (limited to 'docs/DesignDoc.md')
| -rw-r--r-- | docs/DesignDoc.md | 38 |
1 files changed, 33 insertions, 5 deletions
diff --git a/docs/DesignDoc.md b/docs/DesignDoc.md index 80d3778..5d673b2 100644 --- a/docs/DesignDoc.md +++ b/docs/DesignDoc.md @@ -20,12 +20,14 @@ Our project is intended to create a space to fund aquatic conservation, from phy > _**[Sprint 2 & 4]** Provide a very brief statement about the project and the most > important user group and user goals._ + + ### Glossary and Acronyms > _**[Sprint 2 & 4]** Provide a table of terms and acronyms._ -| Term | Definition | -|------|------------| -| SPA | Single Page | +| Term | Definition | +|------|-------------| +| SPA | Single Page | ## Requirements @@ -39,6 +41,8 @@ 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 +54,13 @@ This section describes the features of the application. This section describes the application domain. - + > _**[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 @@ -86,6 +91,25 @@ This section describes the web interface flow; this is how the user views and in > (Add low-fidelity mockups prior to initiating your **[Sprint 2]** work so you have a good idea of the user interactions.) Eventually replace with representative screen shots of your high-fidelity results as these become available and finally include future recommendations improvement recommendations for your **[Sprint 4]** )_ +Home Page: + + +Login Page: + + +Dashboard: + + +Cupboard: + + +Need page: + + +Funding basket: + + + ### View Tier > _**[Sprint 4]** Provide a summary of the View Tier UI of your architecture. > Describe the types of components in the tier and describe their @@ -127,10 +151,12 @@ The Model Tier contains the classes responsible for handling and serving Need da > section will follow the same instructions that are given for the View > Tier above._ +In our model tier we have a Need class, a User class, and a UserAuth class. The Need class represents needs and has fields for all of their values. Users have a passwordHash field, storing a hashed version of their password, an List of integers, representing the ID's of needs in the basket, and the userType which determines their privileges. The UserAuth class stores a key, a username, and expiration. A key is generated for a user and is used to authenticate the user. The username is the name associated with the key and the expiration is how long until the user must login again. + > _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.)_ > - + ## OO Design Principles @@ -157,6 +183,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 |