diff options
| author | benal01 <bja4245@rit.edu> | 2025-04-13 16:00:01 -0400 |
|---|---|---|
| committer | benal01 <bja4245@rit.edu> | 2025-04-13 16:00:01 -0400 |
| commit | 47e728ec7d534e1c82a4a9b6f4191459ffe1ffe9 (patch) | |
| tree | 18ed28f55219dc51e1f3ddf7bd4c237c2f34036f /docs | |
| parent | 52ab3d3a547aa9112772577f975598113eb8320a (diff) | |
| download | JellySolutions-47e728ec7d534e1c82a4a9b6f4191459ffe1ffe9.tar.gz JellySolutions-47e728ec7d534e1c82a4a9b6f4191459ffe1ffe9.tar.bz2 JellySolutions-47e728ec7d534e1c82a4a9b6f4191459ffe1ffe9.zip | |
requirements
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/DesignDoc.md | 42 |
1 files changed, 28 insertions, 14 deletions
diff --git a/docs/DesignDoc.md b/docs/DesignDoc.md index 4b84272..4e0bd4e 100644 --- a/docs/DesignDoc.md +++ b/docs/DesignDoc.md @@ -29,20 +29,22 @@ The purpose of this project is to provide an avenue for companies to crowd-fund > _**[Sprint 2 & 4]** Provide a table of terms and acronyms._ -| Term | Definition | -| ---------- | ---------------------------------------------- | -| SPA | Single Page | -| Need | Element to donate to | -| Contribute | Donate | -| Checkout | Pay / Support | -| DAO | Document Object Model | -| Component | UI Element | -| Models | Structure / Laypout | -| Helper | Contributor / User | -| Manager | Administrator | -| Modal | Pop-up page | -| Toast | On-screen notification | -| API key | Token unique to a sesssion for API interaction | +| Term | Definition | +| -------------- | ---------------------------------------------- | +| SPA | Single Page | +| Need | Element to donate to | +| Contribute | Donate | +| Checkout | Pay / Support | +| DAO | Document Object Model | +| Component | UI Element | +| Models | Structure / Laypout | +| Helper | Contributor / User | +| Manager | Administrator | +| Modal | Pop-up page | +| Toast | On-screen notification | +| API key | Token unique to a sesssion for API interaction | +| JS | Jelly Sollutions | +| Funding basket | User's needs | ## Requirements @@ -54,6 +56,18 @@ The requirements for this u-fund project to be functional include a system for o > story. Focus on top-level features from the Vision document and > maybe Epics and critical Stories._ +#### Uniform Application Design +All pages and components should be consitent in style and layout. The user experience should be consistent across pages. Everything should be clear and consistent for usability, especially if a user is unfamilliar with our site. Usabilty options should consistently apply, such as different layouts, light/dark mode, or different devices across all pages and components. + +#### Layout Information Priority +The most relevant information should always be presented first or be the most visually attracting. Sorting should be able to be controlled by the user in order to access the most relevant information in the cleanest way possible. The layouts should be consistenet across all pages. + +#### Security +Users should only be able to acess API functions that match their user type. When a helper acesses an admin only feature, page or command, they should be re-directed or denied access. API commands are verified through the authentication service, with the API key per session granting access to the commands. This prevents anyone from accessing or modifying data they should not have access to. + +#### Services and Abstractions +Common code and features should be consolidated into services and classes in order to limit repeated functionality. Classes are abstracted where possible, increasing reusability and code quality across the frontend and backend. All components should use the services as much as possible to keep the code clean and understandable for matinence and bugfixing. + ### Definition of MVP > _**[Sprint 2 & 4]** Provide a simple description of the Minimum Viable Product._ |