diff --git a/404.html b/404.html index 2f243f9..8594266 100644 --- a/404.html +++ b/404.html @@ -7,7 +7,7 @@ - +
diff --git a/api.html b/api.html index 0c2ec50..e8ec46c 100644 --- a/api.html +++ b/api.html @@ -21,7 +21,7 @@ - + diff --git a/assets/js/12795a24.a5da76f4.js b/assets/js/12795a24.a5da76f4.js new file mode 100644 index 0000000..66ca956 --- /dev/null +++ b/assets/js/12795a24.a5da76f4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[4774],{20087:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"type":"mdx","permalink":"/projects","source":"@site/src/pages/projects.mdx","description":"Projects","frontMatter":{},"unlisted":false}');var n=s(74848),r=s(28453);const o={},a=void 0,c={},l=[{value:"Projects",id:"projects",level:3}];function d(e){const t={h3:"h3",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h3,{id:"projects",children:"Projects"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Project"}),(0,n.jsx)(t.th,{children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:[(0,n.jsx)(t.strong,{children:"Feedstack"}),(0,n.jsx)("br",{}),"Stephen MacNeil"]}),(0,n.jsx)(t.td,{children:"This project aims to enhance the way feedback is given to learners, particularly on resumes, by linking feedback with design principles such as consistency and specificity. It utilizes ChatGPT to create chapters that help learners understand and apply feedback effectively."})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:[(0,n.jsx)(t.strong,{children:"GitHub Copilot Clone for Education"}),(0,n.jsx)("br",{}),"Stephen MacNeil"]}),(0,n.jsx)(t.td,{children:"The goal is to develop a GitHub Copilot clone that functions similarly but includes rich logging capabilities to monitor user behavior. This project addresses the problem of novices misusing AI coding assistants by providing educational interventions when mistakes are made."})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:[(0,n.jsx)(t.strong,{children:"AAC Play"}),(0,n.jsx)("br",{}),"Cindy Zastudil"]}),(0,n.jsx)(t.td,{children:"This project focuses on enhancing augmentative and alternative communication (AAC) devices for children. It aims to integrate games that encourage social interaction while also providing necessary communication tools for AAC users, potentially reducing social isolation."})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:[(0,n.jsx)(t.strong,{children:"Piggyback Learning"}),(0,n.jsx)("br",{}),"Rahad Arman Nabid"]}),(0,n.jsx)(t.td,{children:"The project involves creating tools to make educational YouTube videos more engaging for children. These tools would inject interactive quizzes and learning materials into videos to improve structured learning experiences."})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:[(0,n.jsx)(t.strong,{children:"Story Builder Project"}),(0,n.jsx)("br",{}),"Rahad Arman Nabid"]}),(0,n.jsx)(t.td,{children:"This project proposes the use of AI agents to automate story creation. It envisions a system where users can generate agents that create story outlines and chapters, which are then voted on for selection. The process is inspired by crowdsourcing but uses AI agents instead of human writers. The system also allows for user edits and aims to create a full story autonomously. The project draws inspiration from existing research on collaborative writing to develop a new method using AI technology."})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:[(0,n.jsx)(t.strong,{children:"3D Printer Security"}),(0,n.jsx)("br",{}),"Daniel Collins"]}),(0,n.jsx)(t.td,{children:"The project involves developing a security tool for 3D printing systems used by the U.S. Navy and Marine Corps. The goal is to create a \u201clast mile\u201d security solution that scans the manufacturing files either before or as they are being sent to the 3D printer. This tool should detect and prevent malicious activities such as wasting materials, overheating, or damaging the printer through unauthorized commands."})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:[(0,n.jsx)(t.strong,{children:"Bioinformatics Software Tutorial Supporting Chatbot"}),(0,n.jsx)("br",{}),"Hannah Kim"]}),(0,n.jsx)(t.td,{children:"This project aims to develop software that uses AI to facilitate learning about bioinformatics. It involves creating a chatbot with retrieval-augmented generation (RAG) capabilities, which can refer to a database to answer user questions. Key features include a customized tutorial experience, a clean web application interface, chat history, use of a free API key to keep costs low, and the ability to admit when it doesn\u2019t know an answer rather than providing incorrect information. This project highlights the potential for interdisciplinary collaboration and overcoming barriers in bioinformatics education."})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},28453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>a});var i=s(96540);const n={},r=i.createContext(n);function o(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/12795a24.d5f81491.js b/assets/js/12795a24.d5f81491.js deleted file mode 100644 index 67506ec..0000000 --- a/assets/js/12795a24.d5f81491.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[4774],{20087:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>r,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"type":"mdx","permalink":"/projects","source":"@site/src/pages/projects.mdx","description":"Feedstack","frontMatter":{},"unlisted":false}');var o=i(74848),a=i(28453);const r={},s=void 0,c={},l=[{value:"Feedstack",id:"feedstack",level:3},{value:"GitHub Copilot Clone for Education",id:"github-copilot-clone-for-education",level:3},{value:"AAC Play",id:"aac-play",level:3},{value:"Piggyback Learning",id:"piggyback-learning",level:3},{value:"3D Printer Security",id:"3d-printer-security",level:3},{value:"Bioinformatics Software Tutorial Supporting Chatbot",id:"bioinformatics-software-tutorial-supporting-chatbot",level:3},{value:"Story Builder Project",id:"story-builder-project",level:3}];function d(e){const t={h3:"h3",p:"p",...(0,a.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.h3,{id:"feedstack",children:"Feedstack"}),"\n",(0,o.jsx)(t.p,{children:"This project aims to enhance the way feedback is given to learners, particularly on resumes, by linking feedback with design principles such as consistency and specificity. It utilizes ChatGPT to create chapters that help learners understand and apply feedback effectively."}),"\n",(0,o.jsx)(t.h3,{id:"github-copilot-clone-for-education",children:"GitHub Copilot Clone for Education"}),"\n",(0,o.jsx)(t.p,{children:"The goal is to develop a GitHub Copilot clone that functions similarly but includes rich logging capabilities to monitor user behavior. This project addresses the problem of novices misusing AI coding assistants by providing educational interventions when mistakes are made."}),"\n",(0,o.jsx)(t.h3,{id:"aac-play",children:"AAC Play"}),"\n",(0,o.jsx)(t.p,{children:"This project focuses on enhancing augmentative and alternative communication (AAC) devices for children. It aims to integrate games that encourage social interaction while also providing necessary communication tools for AAC users, potentially reducing social isolation."}),"\n",(0,o.jsx)(t.h3,{id:"piggyback-learning",children:"Piggyback Learning"}),"\n",(0,o.jsx)(t.p,{children:"The project involves creating tools to make educational YouTube videos more engaging for children. These tools would inject interactive quizzes and learning materials into videos to improve structured learning experiences."}),"\n",(0,o.jsx)(t.h3,{id:"3d-printer-security",children:"3D Printer Security"}),"\n",(0,o.jsx)(t.p,{children:'The project involves developing a security tool for 3D printing systems used by the U.S. Navy and Marine Corps. The goal is to create a "last mile" security solution that scans the manufacturing files either before or as they are being sent to the 3D printer. This tool should detect and prevent malicious activities such as wasting materials, overheating, or damaging the printer through unauthorized commands.'}),"\n",(0,o.jsx)(t.h3,{id:"bioinformatics-software-tutorial-supporting-chatbot",children:"Bioinformatics Software Tutorial Supporting Chatbot"}),"\n",(0,o.jsx)(t.p,{children:"This project aims to develop a software that uses AI to facilitate learning about bioinformatics. It involves creating a chatbot with retrieval-augmented generation (RAG) capabilities, which can refer to a database to answer user questions. Key features include a customized tutorial experience, a clean web application interface, chat history, use of a free API key to keep costs low, and the ability to admit when it doesn't know an answer rather than providing incorrect information. This project highlights the potential for interdisciplinary collaboration and overcoming barriers in bioinformatics education."}),"\n",(0,o.jsx)(t.h3,{id:"story-builder-project",children:"Story Builder Project"}),"\n",(0,o.jsx)(t.p,{children:"This project proposes the use of AI agents to automate story creation. It envisions a system where users can generate agents that create story outlines and chapters, which are then voted on for selection. The process is inspired by crowdsourcing but uses AI agents instead of human writers. The system also allows for user edits and aims to create a full story autonomously. The project draws inspiration from existing research on collaborative writing to develop a new method using AI technology."})]})}function u(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},28453:(e,t,i)=>{i.d(t,{R:()=>r,x:()=>s});var n=i(96540);const o={},a=n.createContext(o);function r(e){const t=n.useContext(a);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function s(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),n.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4be1e2d4.71e29798.js b/assets/js/4be1e2d4.71e29798.js new file mode 100644 index 0000000..3fde9c5 --- /dev/null +++ b/assets/js/4be1e2d4.71e29798.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1110],{14457:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"testing/test-report","title":"Test Report","description":"Purpose","source":"@site/docs/testing/test-report.md","sourceDirName":"testing","slug":"/testing/test-report","permalink":"/docs/testing/test-report","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/testing/test-report.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Acceptance test","permalink":"/docs/testing/acceptence-testing"}}');var r=n(74848),i=n(28453);const o={},a="Test Report",c={},l=[{value:"Purpose",id:"purpose",level:2},{value:"Requirements",id:"requirements",level:3},{value:"README.md/User\u2019s Manual",id:"readmemdusers-manual",level:2},{value:"Purpose",id:"purpose-1",level:3}];function u(e){const t={h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"test-report",children:"Test Report"})}),"\n",(0,r.jsx)(t.h2,{id:"purpose",children:"Purpose"}),"\n",(0,r.jsx)(t.p,{children:"The Test Report is a record that the tests were run and a documentation of their results."}),"\n",(0,r.jsx)(t.h3,{id:"requirements",children:"Requirements"}),"\n",(0,r.jsx)(t.p,{children:"In addition to the general documentation requirements this document will contain: Output from the unit test runs."}),"\n",(0,r.jsx)(t.p,{children:"Output from the integration test runs."}),"\n",(0,r.jsx)(t.p,{children:"Output from automated acceptance tests."}),"\n",(0,r.jsx)(t.p,{children:"A copy of the manual acceptance test procedures with notations indicating that the test was performed and the observed results."}),"\n",(0,r.jsx)(t.p,{children:"List of known problems: describe each failed test."}),"\n",(0,r.jsx)(t.h2,{id:"readmemdusers-manual",children:"README.md/User\u2019s Manual"}),"\n",(0,r.jsx)(t.h3,{id:"purpose-1",children:"Purpose"}),"\n",(0,r.jsx)(t.p,{children:"The User\u2019s Manual describes how to use and maintain the system. It can be presented as two documents, one for the end-user and the other for the maintainer.\nRequirements"}),"\n",(0,r.jsx)(t.p,{children:"In addition to the general documentation requirements the User\u2019s Manual will contain"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Quick Start Guide For the experienced user."}),"\n",(0,r.jsx)(t.li,{children:"Installation Basic installation, network considerations, uninstalls. Installation should be\nautomated and seamless. The system must be responsible for determining if minimum requirements are satisfied. For a client/server system this includes installation of both the client and server software. For a mobile application, it includes build and deployment instructions."}),"\n",(0,r.jsx)(t.li,{children:"Configuration Single user, multi-user, network, resources. Automation is again the key to successful configuration."}),"\n",(0,r.jsx)(t.li,{children:"Security Passwords."}),"\n",(0,r.jsx)(t.li,{children:"Database Installation and maintenance if required."}),"\n",(0,r.jsx)(t.li,{children:"Application Functions System functionality, screen shots. Step-by-step operating\nprocedures."}),"\n",(0,r.jsx)(t.li,{children:"Backup and Recovery"}),"\n",(0,r.jsx)(t.li,{children:"Error Messages Messages and actions. Don\u2019t leave people hanging. When an error is\nreported, there must be a corrective action."}),"\n",(0,r.jsx)(t.li,{children:"Troubleshooting Troubleshoot the application \u2013 not the operating system or network."}),"\n",(0,r.jsx)(t.li,{children:"Support Contacts, contracts"}),"\n"]})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var s=n(96540);const r={},i=s.createContext(r);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4be1e2d4.7302cb55.js b/assets/js/4be1e2d4.7302cb55.js deleted file mode 100644 index c6fc388..0000000 --- a/assets/js/4be1e2d4.7302cb55.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1110],{14457:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"testing/test-report","title":"Test Report","description":"Purpose","source":"@site/docs/testing/test-report.md","sourceDirName":"testing","slug":"/testing/test-report","permalink":"/docs/testing/test-report","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/testing/test-report.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Acceptance test","permalink":"/docs/testing/acceptence-testing"}}');var r=n(74848),i=n(28453);const o={},a="Test Report",c={},l=[{value:"Purpose",id:"purpose",level:2},{value:"Requirements",id:"requirements",level:3},{value:"README.md/User\u2019s Manual",id:"readmemdusers-manual",level:2},{value:"Purpose",id:"purpose-1",level:3}];function u(e){const t={h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"test-report",children:"Test Report"})}),"\n",(0,r.jsx)(t.h2,{id:"purpose",children:"Purpose"}),"\n",(0,r.jsx)(t.p,{children:"The Test Report is a record that the tests were run and a documentation of their results."}),"\n",(0,r.jsx)(t.h3,{id:"requirements",children:"Requirements"}),"\n",(0,r.jsx)(t.p,{children:"In addition to the general documentation requirements this document will contain: Output from the unit test runs."}),"\n",(0,r.jsx)(t.p,{children:"Output from the integration test runs."}),"\n",(0,r.jsx)(t.p,{children:"Output from automated acceptance tests."}),"\n",(0,r.jsx)(t.p,{children:"A copy of the manual acceptance test procedures with notations indicating that the test was performed and the observed results."}),"\n",(0,r.jsx)(t.p,{children:"List of known problems: describe each failed test."}),"\n",(0,r.jsx)(t.h2,{id:"readmemdusers-manual",children:"README.md/User\u2019s Manual"}),"\n",(0,r.jsx)(t.h3,{id:"purpose-1",children:"Purpose"}),"\n",(0,r.jsx)(t.p,{children:"The User\u2019s Manual describes how to use and maintain the system. It can be presented as two documents, one for the end-user and the other for the maintainer.\nRequirements"}),"\n",(0,r.jsx)(t.p,{children:"In addition to the general documentation requirements the User\u2019s Manual will contain"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Quick Start Guide For the experienced user."}),"\n",(0,r.jsx)(t.li,{children:"Installation Basic installation, network considerations, uninstalls. Installation should be\nautomated and seamless. The system must be responsible for determining if minimum requirements are satisfied. For a client/server system this includes installation of both the client and server software. For a mobile application, it includes build and deployment instructions."}),"\n",(0,r.jsx)(t.li,{children:"Configuration Single user, multi-user, network, resources. Automation is again the key to successful configuration."}),"\n",(0,r.jsx)(t.li,{children:"Security Passwords."}),"\n",(0,r.jsx)(t.li,{children:"Database Installation and maintenance if required."}),"\n",(0,r.jsx)(t.li,{children:"Application Functions System functionality, screen shots. Step-by-step operating\nprocedures."}),"\n",(0,r.jsx)(t.li,{children:"Backup and Recovery"}),"\n",(0,r.jsx)(t.li,{children:"Error Messages Messages and actions. Don\u2019t leave people hanging. When an error is\nreported, there must be a corrective action."}),"\n",(0,r.jsx)(t.li,{children:"Troubleshooting Troubleshoot the application \u2013 not the operating system or network."}),"\n",(0,r.jsx)(t.li,{children:"Support Contacts, contracts"}),"\n"]})]})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var s=n(96540);const r={},i=s.createContext(r);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/50de87d6.443a45e3.js b/assets/js/50de87d6.443a45e3.js deleted file mode 100644 index cf9b181..0000000 --- a/assets/js/50de87d6.443a45e3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[3884],{18171:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>u});const r=JSON.parse('{"id":"requirements/Intro","title":"Requirements Documentation","description":"Once you have setup the GitHub Repo, and submitted the Team Git Repository Creation assignment, you will be work on your Requirements Document located in the documentation/docs/requirements/ directory. This document encapsulates everything that makes up your project. Features, use cases, functional and non-functional requirements. This is the very first design document of your project. It serves as a contract between your project team and the project stakeholders. The Requirements Specification defines the functional and non-functional requirements for the product. Those requirements will be verified as a measurement of the project success or failure.","source":"@site/docs/requirements/Intro.md","sourceDirName":"requirements","slug":"/requirements/Intro","permalink":"/docs/requirements/Intro","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/Intro.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Project Proposal","permalink":"/docs/proposal"},"next":{"title":"System Overview","permalink":"/docs/requirements/system-overview"}}');var s=n(74848),i=n(28453);const o={},c="Requirements Documentation",a={},u=[];function d(e){const t={a:"a",code:"code",em:"em",h1:"h1",header:"header",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"requirements-documentation",children:"Requirements Documentation"})}),"\n",(0,s.jsxs)(t.p,{children:["Once you have setup the GitHub Repo, and submitted the ",(0,s.jsx)(t.em,{children:"Team Git Repository Creation"})," assignment, you will be work on your Requirements Document located in the ",(0,s.jsx)(t.code,{children:"documentation/docs/requirements/"})," directory. This document encapsulates everything that makes up your project. Features, use cases, functional and non-functional requirements. This is the very first design document of your project. It serves as a contract between your project team and the project stakeholders. The Requirements Specification defines the functional and non-functional requirements for the product. Those requirements will be verified as a measurement of the project success or failure."]}),"\n",(0,s.jsx)(t.p,{children:"The requirements specification document should contain the following sections:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"System Overview"}),"\n",(0,s.jsx)(t.li,{children:"System Block Diagram"}),"\n",(0,s.jsx)(t.li,{children:"Document Overview"}),"\n",(0,s.jsx)(t.li,{children:"General Requirements"}),"\n",(0,s.jsx)(t.li,{children:"Features and Requirements"}),"\n",(0,s.jsxs)(t.li,{children:["Use-case descriptions:","\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"For each use-case define the triggering event and the interactions between the actor and the system. Normal and alternate flows should be described."}),"\n",(0,s.jsx)(t.li,{children:"As an alternative to use-cases, user stories may be used, provided they are accompanied by scenarios that can form the basis for acceptance testing."}),"\n",(0,s.jsx)(t.li,{children:"diagram or some other diagram that identifies the external interfaces. External interfaces include the user and external hardware or software."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"Revise the Project Proposal document template."}),"\n",(0,s.jsxs)(t.p,{children:["A sample Requirements document ",(0,s.jsx)(t.a,{href:"https://templeu.instructure.com/courses/114202/files/19367286?wrap=1",children:"TempleCatsRequirementsDoc_13_2.docx"})," provided here for your reference."]})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var r=n(96540);const s={},i=r.createContext(s);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/50de87d6.737cdaf5.js b/assets/js/50de87d6.737cdaf5.js new file mode 100644 index 0000000..030f26c --- /dev/null +++ b/assets/js/50de87d6.737cdaf5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[3884],{18171:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>l,frontMatter:()=>o,metadata:()=>r,toc:()=>u});const r=JSON.parse('{"id":"requirements/Intro","title":"Requirements Documentation","description":"Once you have setup the GitHub Repo, and submitted the Team Git Repository Creation assignment, you will be work on your Requirements Document located in the documentation/docs/requirements/ directory. This document encapsulates everything that makes up your project. Features, use cases, functional and non-functional requirements. This is the very first design document of your project. It serves as a contract between your project team and the project stakeholders. The Requirements Specification defines the functional and non-functional requirements for the product. Those requirements will be verified as a measurement of the project success or failure.","source":"@site/docs/requirements/Intro.md","sourceDirName":"requirements","slug":"/requirements/Intro","permalink":"/docs/requirements/Intro","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/Intro.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"Project Proposal","permalink":"/docs/proposal"},"next":{"title":"System Overview","permalink":"/docs/requirements/system-overview"}}');var s=n(74848),i=n(28453);const o={},c="Requirements Documentation",a={},u=[];function d(e){const t={a:"a",code:"code",em:"em",h1:"h1",header:"header",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"requirements-documentation",children:"Requirements Documentation"})}),"\n",(0,s.jsxs)(t.p,{children:["Once you have setup the GitHub Repo, and submitted the ",(0,s.jsx)(t.em,{children:"Team Git Repository Creation"})," assignment, you will be work on your Requirements Document located in the ",(0,s.jsx)(t.code,{children:"documentation/docs/requirements/"})," directory. This document encapsulates everything that makes up your project. Features, use cases, functional and non-functional requirements. This is the very first design document of your project. It serves as a contract between your project team and the project stakeholders. The Requirements Specification defines the functional and non-functional requirements for the product. Those requirements will be verified as a measurement of the project success or failure."]}),"\n",(0,s.jsx)(t.p,{children:"The requirements specification document should contain the following sections:"}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"System Overview"}),"\n",(0,s.jsx)(t.li,{children:"System Block Diagram"}),"\n",(0,s.jsx)(t.li,{children:"Document Overview"}),"\n",(0,s.jsx)(t.li,{children:"General Requirements"}),"\n",(0,s.jsx)(t.li,{children:"Features and Requirements"}),"\n",(0,s.jsxs)(t.li,{children:["Use-case descriptions:","\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:"For each use-case define the triggering event and the interactions between the actor and the system. Normal and alternate flows should be described."}),"\n",(0,s.jsx)(t.li,{children:"As an alternative to use-cases, user stories may be used, provided they are accompanied by scenarios that can form the basis for acceptance testing."}),"\n",(0,s.jsx)(t.li,{children:"diagram or some other diagram that identifies the external interfaces. External interfaces include the user and external hardware or software."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(t.p,{children:"Revise the Project Proposal document template."}),"\n",(0,s.jsxs)(t.p,{children:["A sample Requirements document ",(0,s.jsx)(t.a,{href:"https://templeu.instructure.com/courses/114202/files/19367286?wrap=1",children:"TempleCatsRequirementsDoc_13_2.docx"})," provided here for your reference."]})]})}function l(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var r=n(96540);const s={},i=r.createContext(s);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5314633f.6c0f3d65.js b/assets/js/5314633f.6c0f3d65.js new file mode 100644 index 0000000..a7f7b19 --- /dev/null +++ b/assets/js/5314633f.6c0f3d65.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1730],{45230:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});const o=JSON.parse('{"id":"proposal","title":"Project Proposal","description":"Purpose","source":"@site/docs/proposal.mdx","sourceDirName":".","slug":"/proposal","permalink":"/docs/proposal","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/proposal.mdx","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Project Documentation and Repository","permalink":"/docs/intro"},"next":{"title":"Requirements Documentation","permalink":"/docs/requirements/Intro"}}');var n=r(74848),s=r(28453);const i={sidebar_position:3},a="Project Proposal",l={},c=[{value:"Purpose",id:"purpose",level:2},{value:"Requirements of Project Proposal",id:"requirements-of-project-proposal",level:2},{value:"Project Abstract",id:"project-abstract",level:3},{value:"Top Level Requirements",id:"top-level-requirements",level:3},{value:"Conceptual Design",id:"conceptual-design",level:3},{value:"Required Resources",id:"required-resources",level:3},{value:"Background & References",id:"background--references",level:3},{value:"Proposal Template",id:"proposal-template",level:2}];function d(e){const t={admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"project-proposal",children:"Project Proposal"})}),"\n",(0,n.jsx)(t.h2,{id:"purpose",children:"Purpose"}),"\n",(0,n.jsx)(t.p,{children:"The Project Proposal provides an initial description of the project\u2019s goals. It offers:"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsx)(t.li,{children:"a flavor of what the application will accomplish"}),"\n",(0,n.jsx)(t.li,{children:"why the user should use this application"}),"\n",(0,n.jsx)(t.li,{children:"why this application and approach are superior to the competition\u2019s efforts"}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"It is also an opportunity to recruit certain skills that you may need or that teammates would learn."}),"\n",(0,n.jsx)(t.h2,{id:"requirements-of-project-proposal",children:"Requirements of Project Proposal"}),"\n",(0,n.jsx)(t.p,{children:"The Project Proposal will consist of the following."}),"\n",(0,n.jsx)(t.h3,{id:"project-abstract",children:"Project Abstract"}),"\n",(0,n.jsx)(t.p,{children:'The Project Abstract will be at least 1/2 page, but no more than one-page long. A page is defined as an 8 1/2" \xd7 11" with 1" margins containing 11-point single-spaced text. The Project Abstract will contain.'}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsx)(t.li,{children:"A top-level description of the requirements."}),"\n",(0,n.jsx)(t.li,{children:"A conceptual design."}),"\n",(0,n.jsx)(t.li,{children:"Background reference to similar products."}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"The abstract will not contain phrases such as:"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsx)(t.li,{children:"We are a team from Temple University ..."}),"\n",(0,n.jsx)(t.li,{children:"This application fulfills a class requirement ..."}),"\n",(0,n.jsx)(t.li,{children:"I am doing this because ..."}),"\n",(0,n.jsx)(t.li,{children:"Our team has decided to ..."}),"\n"]}),"\n",(0,n.jsxs)(t.admonition,{type:"tip",children:[(0,n.jsx)(t.p,{children:"Examples can be found on software websites, advertising brochures, and in the introduction section of many manuals."}),(0,n.jsx)(t.p,{children:"Here is a short example:"}),(0,n.jsx)(t.p,{children:"TestItAll sets a new standard for automating software testing and development. A series of user defined menus will enable testers to create easily regression suites without the need to learn a proprietary programming language. And on, and on, and on, for at least half a page of text."})]}),"\n",(0,n.jsx)(t.admonition,{type:"note",children:(0,n.jsx)(t.p,{children:"Project Abstract will be placed on the project development web page/wiki, and repeated as the introduction to all other documents associated with the project.\nOptional, but strongly suggested, a project logo no more than 32 pixels high and no more than 128 pixels wide."})}),"\n",(0,n.jsx)(t.h3,{id:"top-level-requirements",children:"Top Level Requirements"}),"\n",(0,n.jsx)(t.p,{children:"Describe the requirements \u2013 i.e., what the product does and how it does it from a user point of view \u2013 at a high level."}),"\n",(0,n.jsx)(t.h3,{id:"conceptual-design",children:"Conceptual Design"}),"\n",(0,n.jsx)(t.p,{children:"Describe the initial design concept: Hardware/software architecture, programming language, operating system, etc."}),"\n",(0,n.jsx)(t.h3,{id:"required-resources",children:"Required Resources"}),"\n",(0,n.jsx)(t.p,{children:"Discuss what you need to develop this project. This includes background information you will need to acquire, hardware resources, and software resources. If these are not part of the standard Computer Science Department lab resources, these must be identified early and discussed with the instructor."}),"\n",(0,n.jsx)(t.h3,{id:"background--references",children:"Background & References"}),"\n",(0,n.jsx)(t.p,{children:"The background will contain a more detailed description of the product and a comparison to existing similar projects/products. A literature search should be conducted and the results listed. Proper citation of sources is required. If there are similar open-source products, you should state whether existing source will be used and to what extent. If there are similar closed- source/proprietary products, you should state how the proposed product will be similar and different."}),"\n",(0,n.jsx)(t.h2,{id:"proposal-template",children:"Proposal Template"}),"\n",(0,n.jsx)(t.p,{children:"The following is a markdown template for your project proposal. Please use your own words."}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{children:"Keywords\nSection #, as well as any words that quickly give your peers insights into the application like programming language, development platform, type of application, etc.\n\n## Project Abstract\nThis document proposes a novel application of a text message (SMS or Email) read-out and hands-free call interacted between an Android Smartphone and an infotainment platform (headunit) in a car environment. When a phone receives an SMS or Email, the text message is transferred from the phone to the headunit through a Bluetooth connection. On the headunit, user can control which and when the received SMS or E-mail to be read out through the in-vehicle audio system. The user may press one button on the headunit to activate the hands-free feature to call back the SMS sender.\n\n### High Level Requirement\nDescribe the requirements \u2013 i.e., what the product does and how it does it from a user point of view \u2013 at a high level.\n\n### Conceptual Design\nDescribe the initial design concept: Hardware/software architecture, programming language, operating system, etc.\n\n### Required Resources\nDiscuss what you need to develop this project. This includes background information you will need to acquire, hardware resources, and software resources. If these are not part of the standard Computer Science Department lab resources, these must be identified early and discussed with the instructor.\n\n### Background & References\nThe background will contain a more detailed description of the product and a comparison to existing similar projects/products. A literature search should be conducted and the results listed. Proper citation of sources is required. If there are similar open-source products, you should state whether existing source will be used and to what extent. If there are similar closed-source/proprietary products, you should state how the proposed product will be similar and different.\n\n"})})]})}function p(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},28453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>a});var o=r(96540);const n={},s=o.createContext(n);function i(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5314633f.afb25e35.js b/assets/js/5314633f.afb25e35.js deleted file mode 100644 index 712925e..0000000 --- a/assets/js/5314633f.afb25e35.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1730],{45230:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>c});const o=JSON.parse('{"id":"proposal","title":"Project Proposal","description":"Purpose","source":"@site/docs/proposal.mdx","sourceDirName":".","slug":"/proposal","permalink":"/docs/proposal","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/proposal.mdx","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Project Documentation and Repository","permalink":"/docs/intro"},"next":{"title":"Requirements Documentation","permalink":"/docs/requirements/Intro"}}');var n=r(74848),s=r(28453);const i={sidebar_position:3},a="Project Proposal",l={},c=[{value:"Purpose",id:"purpose",level:2},{value:"Requirements of Project Proposal",id:"requirements-of-project-proposal",level:2},{value:"Project Abstract",id:"project-abstract",level:3},{value:"Top Level Requirements",id:"top-level-requirements",level:3},{value:"Conceptual Design",id:"conceptual-design",level:3},{value:"Required Resources",id:"required-resources",level:3},{value:"Background & References",id:"background--references",level:3},{value:"Proposal Template",id:"proposal-template",level:2}];function d(e){const t={admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"project-proposal",children:"Project Proposal"})}),"\n",(0,n.jsx)(t.h2,{id:"purpose",children:"Purpose"}),"\n",(0,n.jsx)(t.p,{children:"The Project Proposal provides an initial description of the project\u2019s goals. It offers:"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsx)(t.li,{children:"a flavor of what the application will accomplish"}),"\n",(0,n.jsx)(t.li,{children:"why the user should use this application"}),"\n",(0,n.jsx)(t.li,{children:"why this application and approach are superior to the competition\u2019s efforts"}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"It is also an opportunity to recruit certain skills that you may need or that teammates would learn."}),"\n",(0,n.jsx)(t.h2,{id:"requirements-of-project-proposal",children:"Requirements of Project Proposal"}),"\n",(0,n.jsx)(t.p,{children:"The Project Proposal will consist of the following."}),"\n",(0,n.jsx)(t.h3,{id:"project-abstract",children:"Project Abstract"}),"\n",(0,n.jsx)(t.p,{children:'The Project Abstract will be at least 1/2 page, but no more than one-page long. A page is defined as an 8 1/2" \xd7 11" with 1" margins containing 11-point single-spaced text. The Project Abstract will contain.'}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsx)(t.li,{children:"A top-level description of the requirements."}),"\n",(0,n.jsx)(t.li,{children:"A conceptual design."}),"\n",(0,n.jsx)(t.li,{children:"Background reference to similar products."}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"The abstract will not contain phrases such as:"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsx)(t.li,{children:"We are a team from Temple University ..."}),"\n",(0,n.jsx)(t.li,{children:"This application fulfills a class requirement ..."}),"\n",(0,n.jsx)(t.li,{children:"I am doing this because ..."}),"\n",(0,n.jsx)(t.li,{children:"Our team has decided to ..."}),"\n"]}),"\n",(0,n.jsxs)(t.admonition,{type:"tip",children:[(0,n.jsx)(t.p,{children:"Examples can be found on software websites, advertising brochures, and in the introduction section of many manuals."}),(0,n.jsx)(t.p,{children:"Here is a short example:"}),(0,n.jsx)(t.p,{children:"TestItAll sets a new standard for automating software testing and development. A series of user defined menus will enable testers to create easily regression suites without the need to learn a proprietary programming language. And on, and on, and on, for at least half a page of text."})]}),"\n",(0,n.jsx)(t.admonition,{type:"note",children:(0,n.jsx)(t.p,{children:"Project Abstract will be placed on the project development web page/wiki, and repeated as the introduction to all other documents associated with the project.\nOptional, but strongly suggested, a project logo no more than 32 pixels high and no more than 128 pixels wide."})}),"\n",(0,n.jsx)(t.h3,{id:"top-level-requirements",children:"Top Level Requirements"}),"\n",(0,n.jsx)(t.p,{children:"Describe the requirements \u2013 i.e., what the product does and how it does it from a user point of view \u2013 at a high level."}),"\n",(0,n.jsx)(t.h3,{id:"conceptual-design",children:"Conceptual Design"}),"\n",(0,n.jsx)(t.p,{children:"Describe the initial design concept: Hardware/software architecture, programming language, operating system, etc."}),"\n",(0,n.jsx)(t.h3,{id:"required-resources",children:"Required Resources"}),"\n",(0,n.jsx)(t.p,{children:"Discuss what you need to develop this project. This includes background information you will need to acquire, hardware resources, and software resources. If these are not part of the standard Computer Science Department lab resources, these must be identified early and discussed with the instructor."}),"\n",(0,n.jsx)(t.h3,{id:"background--references",children:"Background & References"}),"\n",(0,n.jsx)(t.p,{children:"The background will contain a more detailed description of the product and a comparison to existing similar projects/products. A literature search should be conducted and the results listed. Proper citation of sources is required. If there are similar open-source products, you should state whether existing source will be used and to what extent. If there are similar closed- source/proprietary products, you should state how the proposed product will be similar and different."}),"\n",(0,n.jsx)(t.h2,{id:"proposal-template",children:"Proposal Template"}),"\n",(0,n.jsx)(t.p,{children:"The following is a markdown template for your project proposal. Please use your own words."}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{children:"Keywords\nSection #, as well as any words that quickly give your peers insights into the application like programming language, development platform, type of application, etc.\n\n## Project Abstract\nThis document proposes a novel application of a text message (SMS or Email) read-out and hands-free call interacted between an Android Smartphone and an infotainment platform (headunit) in a car environment. When a phone receives an SMS or Email, the text message is transferred from the phone to the headunit through a Bluetooth connection. On the headunit, user can control which and when the received SMS or E-mail to be read out through the in-vehicle audio system. The user may press one button on the headunit to activate the hands-free feature to call back the SMS sender.\n\n### High Level Requirement\nDescribe the requirements \u2013 i.e., what the product does and how it does it from a user point of view \u2013 at a high level.\n\n### Conceptual Design\nDescribe the initial design concept: Hardware/software architecture, programming language, operating system, etc.\n\n### Required Resources\nDiscuss what you need to develop this project. This includes background information you will need to acquire, hardware resources, and software resources. If these are not part of the standard Computer Science Department lab resources, these must be identified early and discussed with the instructor.\n\n### Background & References\nThe background will contain a more detailed description of the product and a comparison to existing similar projects/products. A literature search should be conducted and the results listed. Proper citation of sources is required. If there are similar open-source products, you should state whether existing source will be used and to what extent. If there are similar closed-source/proprietary products, you should state how the proposed product will be similar and different.\n\n"})})]})}function p(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},28453:(e,t,r)=>{r.d(t,{R:()=>i,x:()=>a});var o=r(96540);const n={},s=o.createContext(n);function i(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:i(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5410c81d.4986cee8.js b/assets/js/5410c81d.4986cee8.js deleted file mode 100644 index 2b280b5..0000000 --- a/assets/js/5410c81d.4986cee8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[6993],{73810:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>c,default:()=>d,frontMatter:()=>a,metadata:()=>i,toc:()=>p});const i=JSON.parse('{"id":"development-plan/activities","title":"Activities","description":"","source":"@site/docs/development-plan/activities.md","sourceDirName":"development-plan","slug":"/development-plan/activities","permalink":"/docs/development-plan/activities","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/development-plan/activities.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Software Development Plan","permalink":"/docs/development-plan/Intro"},"next":{"title":"Tasks","permalink":"/docs/development-plan/tasks"}}');var s=n(74848),o=n(28453);const a={sidebar_position:1},c="Activities",r={},p=[];function l(e){const t={h1:"h1",header:"header",...(0,o.R)(),...e.components};return(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"activities",children:"Activities"})})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>c});var i=n(96540);const s={},o=i.createContext(s);function a(e){const t=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5410c81d.ea86d07a.js b/assets/js/5410c81d.ea86d07a.js new file mode 100644 index 0000000..d676c98 --- /dev/null +++ b/assets/js/5410c81d.ea86d07a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[6993],{73810:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>a,metadata:()=>i,toc:()=>p});const i=JSON.parse('{"id":"development-plan/activities","title":"Activities","description":"","source":"@site/docs/development-plan/activities.md","sourceDirName":"development-plan","slug":"/development-plan/activities","permalink":"/docs/development-plan/activities","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/development-plan/activities.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Software Development Plan","permalink":"/docs/development-plan/Intro"},"next":{"title":"Tasks","permalink":"/docs/development-plan/tasks"}}');var s=n(74848),o=n(28453);const a={sidebar_position:1},c="Activities",r={},p=[];function d(e){const t={h1:"h1",header:"header",...(0,o.R)(),...e.components};return(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"activities",children:"Activities"})})}function l(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>c});var i=n(96540);const s={},o=i.createContext(s);function a(e){const t=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5bc0003a.4ee4c6c3.js b/assets/js/5bc0003a.4ee4c6c3.js new file mode 100644 index 0000000..cf6a672 --- /dev/null +++ b/assets/js/5bc0003a.4ee4c6c3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[635],{19950:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>m});const r=JSON.parse('{"id":"requirements/system-block-diagram","title":"System Block Diagram","description":"","source":"@site/docs/requirements/system-block-diagram.md","sourceDirName":"requirements","slug":"/requirements/system-block-diagram","permalink":"/docs/requirements/system-block-diagram","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/system-block-diagram.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":2,"frontMatter":{"sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"System Overview","permalink":"/docs/requirements/system-overview"},"next":{"title":"General Requirements","permalink":"/docs/requirements/general-requirements"}}');var n=s(74848),i=s(28453);const o={sidebar_position:2},a="System Block Diagram",c={},m=[];function d(e){const t={h1:"h1",header:"header",...(0,i.R)(),...e.components};return(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"system-block-diagram",children:"System Block Diagram"})})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},28453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>a});var r=s(96540);const n={},i=r.createContext(n);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5bc0003a.c1ee955a.js b/assets/js/5bc0003a.c1ee955a.js deleted file mode 100644 index 637f125..0000000 --- a/assets/js/5bc0003a.c1ee955a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[635],{19950:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>r,toc:()=>m});const r=JSON.parse('{"id":"requirements/system-block-diagram","title":"System Block Diagram","description":"","source":"@site/docs/requirements/system-block-diagram.md","sourceDirName":"requirements","slug":"/requirements/system-block-diagram","permalink":"/docs/requirements/system-block-diagram","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/system-block-diagram.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":2,"frontMatter":{"sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"System Overview","permalink":"/docs/requirements/system-overview"},"next":{"title":"General Requirements","permalink":"/docs/requirements/general-requirements"}}');var n=s(74848),i=s(28453);const o={sidebar_position:2},a="System Block Diagram",c={},m=[];function d(e){const t={h1:"h1",header:"header",...(0,i.R)(),...e.components};return(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"system-block-diagram",children:"System Block Diagram"})})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},28453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>a});var r=s(96540);const n={},i=r.createContext(n);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5fe3224b.278ce150.js b/assets/js/5fe3224b.278ce150.js new file mode 100644 index 0000000..25703b8 --- /dev/null +++ b/assets/js/5fe3224b.278ce150.js @@ -0,0 +1 @@ +(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1940],{57259:(e,t,i)=>{"use strict";i.r(t),i.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>m,frontMatter:()=>a,metadata:()=>o,toc:()=>u});const o=JSON.parse('{"id":"api-specification/openapi-spec-petstore","title":"API 1 - Swagger Petstore","description":"API Specification from openapi.yml","source":"@site/docs/api-specification/openapi-spec-petstore.md","sourceDirName":"api-specification","slug":"/api-specification/openapi-spec-petstore","permalink":"/docs/api-specification/openapi-spec-petstore","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/api-specification/openapi-spec-petstore.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":3,"frontMatter":{"title":"API 1 - Swagger Petstore","description":"API Specification from openapi.yml","hide_table_of_contents":true,"sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"CalculatorModel.java","permalink":"/docs/api-specification/calculator-model-generated"},"next":{"title":"Test Procedures","permalink":"/docs/testing/Intro"}}');var n=i(74848),s=i(28453),r=i(66216),c=i(4784);const a={title:"API 1 - Swagger Petstore",description:"API Specification from openapi.yml",hide_table_of_contents:!0,sidebar_position:3},p=void 0,d={},u=[];function l(e){return(0,n.jsx)(n.Fragment,{children:(0,n.jsx)(n.Fragment,{children:c.default.customFields.is_pdf?(0,n.jsx)(n.Fragment,{}):(0,n.jsx)(r.A,{id:"using-petstore-yaml"})})})}function m(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l()}},66216:(e,t,i)=>{"use strict";i.d(t,{A:()=>a});var o=i(96540),n=i(27177),s=i(72077);const r=function(e){const t=(0,s.kh)("docusaurus-plugin-redoc");return e?t?.[e]:Object.values(t??{})?.[0]};var c=i(74848);const a=e=>{let{id:t}=e;const i=r(t),s=(0,o.useMemo)((()=>({theme:{breakpoints:{medium:"130rem",large:"130rem"}}})),[]);return(0,c.jsx)(n.A,{...i,optionsOverrides:s})}},26903:()=>{},14834:()=>{},20922:()=>{},32413:()=>{},81912:()=>{},28453:(e,t,i)=>{"use strict";i.d(t,{R:()=>r,x:()=>c});var o=i(96540);const n={},s=o.createContext(n);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5fe3224b.789a1299.js b/assets/js/5fe3224b.789a1299.js deleted file mode 100644 index 2d2f5c7..0000000 --- a/assets/js/5fe3224b.789a1299.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1940],{57259:(e,t,i)=>{"use strict";i.r(t),i.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>m,frontMatter:()=>a,metadata:()=>o,toc:()=>u});const o=JSON.parse('{"id":"api-specification/openapi-spec-petstore","title":"API 1 - Swagger Petstore","description":"API Specification from openapi.yml","source":"@site/docs/api-specification/openapi-spec-petstore.md","sourceDirName":"api-specification","slug":"/api-specification/openapi-spec-petstore","permalink":"/docs/api-specification/openapi-spec-petstore","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/api-specification/openapi-spec-petstore.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":3,"frontMatter":{"title":"API 1 - Swagger Petstore","description":"API Specification from openapi.yml","hide_table_of_contents":true,"sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"CalculatorModel.java","permalink":"/docs/api-specification/calculator-model-generated"},"next":{"title":"Test Procedures","permalink":"/docs/testing/Intro"}}');var n=i(74848),s=i(28453),r=i(66216),c=i(4784);const a={title:"API 1 - Swagger Petstore",description:"API Specification from openapi.yml",hide_table_of_contents:!0,sidebar_position:3},p=void 0,d={},u=[];function l(e){return(0,n.jsx)(n.Fragment,{children:(0,n.jsx)(n.Fragment,{children:c.default.customFields.is_pdf?(0,n.jsx)(n.Fragment,{}):(0,n.jsx)(r.A,{id:"using-petstore-yaml"})})})}function m(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l()}},66216:(e,t,i)=>{"use strict";i.d(t,{A:()=>a});var o=i(96540),n=i(27177),s=i(72077);const r=function(e){const t=(0,s.kh)("docusaurus-plugin-redoc");return e?t?.[e]:Object.values(t??{})?.[0]};var c=i(74848);const a=e=>{let{id:t}=e;const i=r(t),s=(0,o.useMemo)((()=>({theme:{breakpoints:{medium:"130rem",large:"130rem"}}})),[]);return(0,c.jsx)(n.A,{...i,optionsOverrides:s})}},26903:()=>{},14834:()=>{},20922:()=>{},32413:()=>{},81912:()=>{},28453:(e,t,i)=>{"use strict";i.d(t,{R:()=>r,x:()=>c});var o=i(96540);const n={},s=o.createContext(n);function r(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/61760bca.1edd055a.js b/assets/js/61760bca.1edd055a.js new file mode 100644 index 0000000..78f2779 --- /dev/null +++ b/assets/js/61760bca.1edd055a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[3689],{39638:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>a});const o=JSON.parse('{"id":"development-plan/version-control","title":"Version Control","description":"","source":"@site/docs/development-plan/version-control.md","sourceDirName":"development-plan","slug":"/development-plan/version-control","permalink":"/docs/development-plan/version-control","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/development-plan/version-control.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":5,"frontMatter":{"sidebar_position":5},"sidebar":"docsSidebar","previous":{"title":"Development Environment","permalink":"/docs/development-plan/development-environment"},"next":{"title":"System Architecture","permalink":"/docs/system-architecture/Intro"}}');var r=n(74848),s=n(28453);const i={sidebar_position:5},c="Version Control",l={},a=[];function p(e){const t={h1:"h1",header:"header",...(0,s.R)(),...e.components};return(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"version-control",children:"Version Control"})})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>c});var o=n(96540);const r={},s=o.createContext(r);function i(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/61760bca.44b21aa6.js b/assets/js/61760bca.44b21aa6.js deleted file mode 100644 index cc600d6..0000000 --- a/assets/js/61760bca.44b21aa6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[3689],{39638:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>a});const o=JSON.parse('{"id":"development-plan/version-control","title":"Version Control","description":"","source":"@site/docs/development-plan/version-control.md","sourceDirName":"development-plan","slug":"/development-plan/version-control","permalink":"/docs/development-plan/version-control","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/development-plan/version-control.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":5,"frontMatter":{"sidebar_position":5},"sidebar":"docsSidebar","previous":{"title":"Development Environment","permalink":"/docs/development-plan/development-environment"},"next":{"title":"System Architecture","permalink":"/docs/system-architecture/Intro"}}');var r=n(74848),s=n(28453);const i={sidebar_position:5},c="Version Control",l={},a=[];function p(e){const t={h1:"h1",header:"header",...(0,s.R)(),...e.components};return(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"version-control",children:"Version Control"})})}function d(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(p,{...e})}):p(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>c});var o=n(96540);const r={},s=o.createContext(r);function i(e){const t=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/636a28c3.b15a12e0.js b/assets/js/636a28c3.b15a12e0.js deleted file mode 100644 index 89f8e82..0000000 --- a/assets/js/636a28c3.b15a12e0.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1109],{64085:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>c,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"id":"system-architecture/Intro","title":"System Architechture","description":"Purpose","source":"@site/docs/system-architecture/Intro.md","sourceDirName":"system-architecture","slug":"/system-architecture/Intro","permalink":"/docs/system-architecture/Intro","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/system-architecture/Intro.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Version Control","permalink":"/docs/development-plan/version-control"},"next":{"title":"Design Document - Part II API","permalink":"/docs/api-specification/Intro"}}');var s=r(74848),i=r(28453);const c={sidebar_position:1},a="System Architechture",o={},d=[{value:"Purpose",id:"purpose",level:2},{value:"Requirements",id:"requirements",level:2}];function h(e){const t={a:"a",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"system-architechture",children:"System Architechture"})}),"\n",(0,s.jsx)(t.h2,{id:"purpose",children:"Purpose"}),"\n",(0,s.jsx)(t.p,{children:"The Design Document - Part I Architecture describes the software architecture and how the requirements are mapped into the design. This document will be a combination of diagrams and text that describes what the diagrams are showing."}),"\n",(0,s.jsx)(t.h2,{id:"requirements",children:"Requirements"}),"\n",(0,s.jsx)(t.p,{children:"In addition to the general requirements the Design Document - Part I Architecture will contain:"}),"\n",(0,s.jsx)(t.p,{children:"A description the different components and their interfaces. For example: client, server, database."}),"\n",(0,s.jsx)(t.p,{children:"For each component provide class diagrams showing the classes to be developed (or used) and their relationship."}),"\n",(0,s.jsxs)(t.p,{children:["Sequence diagrams showing the data flow for ",(0,s.jsx)(t.em,{children:"all"})," use cases.\xa0One sequence diagram corresponds to one use case and different use cases should have different corresponding sequence diagrams."]}),"\n",(0,s.jsx)(t.p,{children:"Describe algorithms employed in your project, e.g. neural network paradigm, training and training data set, etc."}),"\n",(0,s.jsx)(t.p,{children:"If there is a database:"}),"\n",(0,s.jsx)(t.p,{children:"Entity-relation diagram."}),"\n",(0,s.jsx)(t.p,{children:"Table design."}),"\n",(0,s.jsxs)(t.p,{children:["A check list for architecture design is attached here ",(0,s.jsx)(t.a,{href:"https://templeu.instructure.com/courses/106563/files/16928870/download?wrap=1",title:"architecture_design_checklist.pdf",children:"architecture_design_checklist.pdf"}),"\xa0 and should be used as a guidance."]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},28453:(e,t,r)=>{r.d(t,{R:()=>c,x:()=>a});var n=r(96540);const s={},i=n.createContext(s);function c(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/636a28c3.b1a2d234.js b/assets/js/636a28c3.b1a2d234.js new file mode 100644 index 0000000..9691623 --- /dev/null +++ b/assets/js/636a28c3.b1a2d234.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1109],{64085:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>a,default:()=>u,frontMatter:()=>c,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"id":"system-architecture/Intro","title":"System Architechture","description":"Purpose","source":"@site/docs/system-architecture/Intro.md","sourceDirName":"system-architecture","slug":"/system-architecture/Intro","permalink":"/docs/system-architecture/Intro","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/system-architecture/Intro.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Version Control","permalink":"/docs/development-plan/version-control"},"next":{"title":"Design Document - Part II API","permalink":"/docs/api-specification/Intro"}}');var s=r(74848),i=r(28453);const c={sidebar_position:1},a="System Architechture",o={},d=[{value:"Purpose",id:"purpose",level:2},{value:"Requirements",id:"requirements",level:2}];function h(e){const t={a:"a",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"system-architechture",children:"System Architechture"})}),"\n",(0,s.jsx)(t.h2,{id:"purpose",children:"Purpose"}),"\n",(0,s.jsx)(t.p,{children:"The Design Document - Part I Architecture describes the software architecture and how the requirements are mapped into the design. This document will be a combination of diagrams and text that describes what the diagrams are showing."}),"\n",(0,s.jsx)(t.h2,{id:"requirements",children:"Requirements"}),"\n",(0,s.jsx)(t.p,{children:"In addition to the general requirements the Design Document - Part I Architecture will contain:"}),"\n",(0,s.jsx)(t.p,{children:"A description the different components and their interfaces. For example: client, server, database."}),"\n",(0,s.jsx)(t.p,{children:"For each component provide class diagrams showing the classes to be developed (or used) and their relationship."}),"\n",(0,s.jsxs)(t.p,{children:["Sequence diagrams showing the data flow for ",(0,s.jsx)(t.em,{children:"all"})," use cases.\xa0One sequence diagram corresponds to one use case and different use cases should have different corresponding sequence diagrams."]}),"\n",(0,s.jsx)(t.p,{children:"Describe algorithms employed in your project, e.g. neural network paradigm, training and training data set, etc."}),"\n",(0,s.jsx)(t.p,{children:"If there is a database:"}),"\n",(0,s.jsx)(t.p,{children:"Entity-relation diagram."}),"\n",(0,s.jsx)(t.p,{children:"Table design."}),"\n",(0,s.jsxs)(t.p,{children:["A check list for architecture design is attached here ",(0,s.jsx)(t.a,{href:"https://templeu.instructure.com/courses/106563/files/16928870/download?wrap=1",title:"architecture_design_checklist.pdf",children:"architecture_design_checklist.pdf"}),"\xa0 and should be used as a guidance."]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},28453:(e,t,r)=>{r.d(t,{R:()=>c,x:()=>a});var n=r(96540);const s={},i=n.createContext(s);function c(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/651d1379.16b6dbf6.js b/assets/js/651d1379.16b6dbf6.js new file mode 100644 index 0000000..37b8069 --- /dev/null +++ b/assets/js/651d1379.16b6dbf6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[3579],{70045:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"id":"requirements/use-case-descriptions","title":"Use-case descriptions","description":"","source":"@site/docs/requirements/use-case-descriptions.md","sourceDirName":"requirements","slug":"/requirements/use-case-descriptions","permalink":"/docs/requirements/use-case-descriptions","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/use-case-descriptions.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":5,"frontMatter":{"sidebar_position":5},"sidebar":"docsSidebar","previous":{"title":"Features and Requirements","permalink":"/docs/requirements/features-and-requirements"},"next":{"title":"Software Development Plan","permalink":"/docs/development-plan/Intro"}}');var r=s(74848),i=s(28453);const o={sidebar_position:5},c="Use-case descriptions",a={},d=[];function u(e){const t={h1:"h1",header:"header",...(0,i.R)(),...e.components};return(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"use-case-descriptions",children:"Use-case descriptions"})})}function p(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},28453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>c});var n=s(96540);const r={},i=n.createContext(r);function o(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/651d1379.7ac12bec.js b/assets/js/651d1379.7ac12bec.js deleted file mode 100644 index ff164d3..0000000 --- a/assets/js/651d1379.7ac12bec.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[3579],{70045:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"id":"requirements/use-case-descriptions","title":"Use-case descriptions","description":"","source":"@site/docs/requirements/use-case-descriptions.md","sourceDirName":"requirements","slug":"/requirements/use-case-descriptions","permalink":"/docs/requirements/use-case-descriptions","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/use-case-descriptions.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":5,"frontMatter":{"sidebar_position":5},"sidebar":"docsSidebar","previous":{"title":"Features and Requirements","permalink":"/docs/requirements/features-and-requirements"},"next":{"title":"Software Development Plan","permalink":"/docs/development-plan/Intro"}}');var r=s(74848),i=s(28453);const o={sidebar_position:5},c="Use-case descriptions",a={},d=[];function u(e){const t={h1:"h1",header:"header",...(0,i.R)(),...e.components};return(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"use-case-descriptions",children:"Use-case descriptions"})})}function p(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},28453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>c});var n=s(96540);const r={},i=n.createContext(r);function o(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/68a18ae0.6f9715b3.js b/assets/js/68a18ae0.6f9715b3.js new file mode 100644 index 0000000..d0238e7 --- /dev/null +++ b/assets/js/68a18ae0.6f9715b3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[7277],{13863:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"testing/Intro","title":"Test Procedures","description":"Purpose","source":"@site/docs/testing/Intro.md","sourceDirName":"testing","slug":"/testing/Intro","permalink":"/docs/testing/Intro","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/testing/Intro.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"API 1 - Swagger Petstore","permalink":"/docs/api-specification/openapi-spec-petstore"},"next":{"title":"Unit tests","permalink":"/docs/testing/unit-testing"}}');var r=n(74848),i=n(28453);const o={},c="Test Procedures",a={},d=[{value:"Purpose",id:"purpose",level:2},{value:"Requirements",id:"requirements",level:2}];function l(e){const t={h1:"h1",h2:"h2",header:"header",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"test-procedures",children:"Test Procedures"})}),"\n",(0,r.jsx)(t.h2,{id:"purpose",children:"Purpose"}),"\n",(0,r.jsx)(t.p,{children:"The Test Procedures describe the test approach and the tests to be performed to verify the requirements specified in the Requirements Document."}),"\n",(0,r.jsx)(t.h2,{id:"requirements",children:"Requirements"}),"\n",(0,r.jsx)(t.p,{children:"In addition to the general documentation requirements this document will contain the procedures for the following tests:"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:"Unit tests"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"For each method, one or more test cases."}),"\n",(0,r.jsx)(t.li,{children:"A test case consists of input parameter values and expected results. All external classes should be stubbed using mock objects."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:"Integration tests"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Tests to demonstrate each use-case based on the use-case descriptions and the sequence diagrams. External input should be provided via mock objects and results verified via mock objects. Integration tests should not require manual entry of data nor require manual interpretation of results."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:"Acceptance test"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Demonstration of all of the functional and non-functional requirements. This can be a combination of automated tests derived from the use-cases (user stories) and manual tests with recorded observation of the results."}),"\n"]}),"\n"]}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var s=n(96540);const r={},i=s.createContext(r);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/68a18ae0.bb934be9.js b/assets/js/68a18ae0.bb934be9.js deleted file mode 100644 index e21e241..0000000 --- a/assets/js/68a18ae0.bb934be9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[7277],{13863:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"testing/Intro","title":"Test Procedures","description":"Purpose","source":"@site/docs/testing/Intro.md","sourceDirName":"testing","slug":"/testing/Intro","permalink":"/docs/testing/Intro","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/testing/Intro.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"API 1 - Swagger Petstore","permalink":"/docs/api-specification/openapi-spec-petstore"},"next":{"title":"Unit tests","permalink":"/docs/testing/unit-testing"}}');var r=n(74848),i=n(28453);const o={},c="Test Procedures",a={},d=[{value:"Purpose",id:"purpose",level:2},{value:"Requirements",id:"requirements",level:2}];function l(e){const t={h1:"h1",h2:"h2",header:"header",li:"li",p:"p",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"test-procedures",children:"Test Procedures"})}),"\n",(0,r.jsx)(t.h2,{id:"purpose",children:"Purpose"}),"\n",(0,r.jsx)(t.p,{children:"The Test Procedures describe the test approach and the tests to be performed to verify the requirements specified in the Requirements Document."}),"\n",(0,r.jsx)(t.h2,{id:"requirements",children:"Requirements"}),"\n",(0,r.jsx)(t.p,{children:"In addition to the general documentation requirements this document will contain the procedures for the following tests:"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:"Unit tests"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"For each method, one or more test cases."}),"\n",(0,r.jsx)(t.li,{children:"A test case consists of input parameter values and expected results. All external classes should be stubbed using mock objects."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:"Integration tests"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Tests to demonstrate each use-case based on the use-case descriptions and the sequence diagrams. External input should be provided via mock objects and results verified via mock objects. Integration tests should not require manual entry of data nor require manual interpretation of results."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:["\n",(0,r.jsx)(t.p,{children:"Acceptance test"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"Demonstration of all of the functional and non-functional requirements. This can be a combination of automated tests derived from the use-cases (user stories) and manual tests with recorded observation of the results."}),"\n"]}),"\n"]}),"\n"]})]})}function u(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var s=n(96540);const r={},i=s.createContext(r);function o(e){const t=s.useContext(i);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/72dce597.3fb837a8.js b/assets/js/72dce597.3fb837a8.js new file mode 100644 index 0000000..de7b21f --- /dev/null +++ b/assets/js/72dce597.3fb837a8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1401],{59564:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>c,default:()=>l,frontMatter:()=>i,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"development-plan/tasks","title":"Tasks","description":"","source":"@site/docs/development-plan/tasks.md","sourceDirName":"development-plan","slug":"/development-plan/tasks","permalink":"/docs/development-plan/tasks","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/development-plan/tasks.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":2,"frontMatter":{"sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Activities","permalink":"/docs/development-plan/activities"},"next":{"title":"Schedule","permalink":"/docs/development-plan/schedule"}}');var o=n(74848),a=n(28453);const i={sidebar_position:2},c="Tasks",r={},d=[];function p(e){const t={h1:"h1",header:"header",...(0,a.R)(),...e.components};return(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"tasks",children:"Tasks"})})}function l(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>c});var s=n(96540);const o={},a=s.createContext(o);function i(e){const t=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/72dce597.a00e939b.js b/assets/js/72dce597.a00e939b.js deleted file mode 100644 index 0b8e15e..0000000 --- a/assets/js/72dce597.a00e939b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1401],{59564:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>c,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"development-plan/tasks","title":"Tasks","description":"","source":"@site/docs/development-plan/tasks.md","sourceDirName":"development-plan","slug":"/development-plan/tasks","permalink":"/docs/development-plan/tasks","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/development-plan/tasks.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":2,"frontMatter":{"sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Activities","permalink":"/docs/development-plan/activities"},"next":{"title":"Schedule","permalink":"/docs/development-plan/schedule"}}');var o=n(74848),a=n(28453);const i={sidebar_position:2},c="Tasks",r={},d=[];function l(e){const t={h1:"h1",header:"header",...(0,a.R)(),...e.components};return(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"tasks",children:"Tasks"})})}function p(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>c});var s=n(96540);const o={},a=s.createContext(o);function i(e){const t=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),s.createElement(a.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/83adae89.59905348.js b/assets/js/83adae89.59905348.js new file mode 100644 index 0000000..10f1d30 --- /dev/null +++ b/assets/js/83adae89.59905348.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[116],{58883:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"requirements/general-requirements","title":"General Requirements","description":"","source":"@site/docs/requirements/general-requirements.md","sourceDirName":"requirements","slug":"/requirements/general-requirements","permalink":"/docs/requirements/general-requirements","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/general-requirements.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"System Block Diagram","permalink":"/docs/requirements/system-block-diagram"},"next":{"title":"Features and Requirements","permalink":"/docs/requirements/features-and-requirements"}}');var s=n(74848),i=n(28453);const o={sidebar_position:3},a="General Requirements",u={},c=[];function m(e){const t={h1:"h1",header:"header",...(0,i.R)(),...e.components};return(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"general-requirements",children:"General Requirements"})})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(m,{...e})}):m(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>a});var r=n(96540);const s={},i=r.createContext(s);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/83adae89.ca4e042b.js b/assets/js/83adae89.ca4e042b.js deleted file mode 100644 index da37f3e..0000000 --- a/assets/js/83adae89.ca4e042b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[116],{58883:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>a,default:()=>d,frontMatter:()=>o,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"requirements/general-requirements","title":"General Requirements","description":"","source":"@site/docs/requirements/general-requirements.md","sourceDirName":"requirements","slug":"/requirements/general-requirements","permalink":"/docs/requirements/general-requirements","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/general-requirements.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"System Block Diagram","permalink":"/docs/requirements/system-block-diagram"},"next":{"title":"Features and Requirements","permalink":"/docs/requirements/features-and-requirements"}}');var s=r(74848),i=r(28453);const o={sidebar_position:3},a="General Requirements",u={},c=[];function m(e){const t={h1:"h1",header:"header",...(0,i.R)(),...e.components};return(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"general-requirements",children:"General Requirements"})})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(m,{...e})}):m(e)}},28453:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>a});var n=r(96540);const s={},i=n.createContext(s);function o(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8c39825e.633c22c6.js b/assets/js/8c39825e.633c22c6.js new file mode 100644 index 0000000..b40626a --- /dev/null +++ b/assets/js/8c39825e.633c22c6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[6984],{2012:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>i});const s=JSON.parse('{"id":"development-plan/schedule","title":"Schedule","description":"","source":"@site/docs/development-plan/schedule.md","sourceDirName":"development-plan","slug":"/development-plan/schedule","permalink":"/docs/development-plan/schedule","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/development-plan/schedule.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Tasks","permalink":"/docs/development-plan/tasks"},"next":{"title":"Development Environment","permalink":"/docs/development-plan/development-environment"}}');var d=n(74848),o=n(28453);const a={sidebar_position:3},r="Schedule",c={},i=[];function l(e){const t={h1:"h1",header:"header",mermaid:"mermaid",...(0,o.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(t.header,{children:(0,d.jsx)(t.h1,{id:"schedule",children:"Schedule"})}),"\n",(0,d.jsx)(t.mermaid,{value:"gantt\ndateFormat YYYY-MM-DD\ntitle Adding GANTT diagram to mermaid\nexcludes weekdays 2014-01-10\n\nsection A section\nCompleted task :done, des1, 2014-01-06,2014-01-08\nActive task :active, des2, 2014-01-09, 3d\nFuture task : des3, after des2, 5d\nFuture task2 : des4, after des3, 5d"})]})}function p(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>r});var s=n(96540);const d={},o=s.createContext(d);function a(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:a(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8c39825e.a00b0652.js b/assets/js/8c39825e.a00b0652.js deleted file mode 100644 index cb7171a..0000000 --- a/assets/js/8c39825e.a00b0652.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[6984],{2012:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>i});const s=JSON.parse('{"id":"development-plan/schedule","title":"Schedule","description":"","source":"@site/docs/development-plan/schedule.md","sourceDirName":"development-plan","slug":"/development-plan/schedule","permalink":"/docs/development-plan/schedule","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/development-plan/schedule.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"Tasks","permalink":"/docs/development-plan/tasks"},"next":{"title":"Development Environment","permalink":"/docs/development-plan/development-environment"}}');var d=n(74848),o=n(28453);const a={sidebar_position:3},r="Schedule",c={},i=[];function l(e){const t={h1:"h1",header:"header",mermaid:"mermaid",...(0,o.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(t.header,{children:(0,d.jsx)(t.h1,{id:"schedule",children:"Schedule"})}),"\n",(0,d.jsx)(t.mermaid,{value:"gantt\ndateFormat YYYY-MM-DD\ntitle Adding GANTT diagram to mermaid\nexcludes weekdays 2014-01-10\n\nsection A section\nCompleted task :done, des1, 2014-01-06,2014-01-08\nActive task :active, des2, 2014-01-09, 3d\nFuture task : des3, after des2, 5d\nFuture task2 : des4, after des3, 5d"})]})}function p(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>r});var s=n(96540);const d={},o=s.createContext(d);function a(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:a(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/986fb218.6a39ed4d.js b/assets/js/986fb218.6a39ed4d.js deleted file mode 100644 index 28a74de..0000000 --- a/assets/js/986fb218.6a39ed4d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[9623],{30454:(e,i,t)=>{t.r(i),t.d(i,{assets:()=>o,contentTitle:()=>d,default:()=>u,frontMatter:()=>a,metadata:()=>l,toc:()=>s});const l=JSON.parse('{"id":"api-specification/calculator-model-generated","title":"CalculatorModel.java","description":"(generated using Javadoc to Markdown)","source":"@site/docs/api-specification/calculator-model-generated.md","sourceDirName":"api-specification","slug":"/api-specification/calculator-model-generated","permalink":"/docs/api-specification/calculator-model-generated","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/api-specification/calculator-model-generated.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"API 1 - Courses API","permalink":"/docs/api-specification/openapi-spec"},"next":{"title":"API 1 - Swagger Petstore","permalink":"/docs/api-specification/openapi-spec-petstore"}}');var n=t(74848),r=t(28453);const a={sidebar_position:3},d="CalculatorModel.java",o={},s=[{value:"public class CalculatorModel
",id:"public-class-calculatormodel",level:2},{value:"private double displayValue
",id:"private-double-displayvalue",level:2},{value:"private double internalValue
",id:"private-double-internalvalue",level:2},{value:"private String displayString
",id:"private-string-displaystring",level:2},{value:"private String operation
",id:"private-string-operation",level:2},{value:"private boolean start
",id:"private-boolean-start",level:2},{value:"private boolean dot
",id:"private-boolean-dot",level:2},{value:"public CalculatorModel()
",id:"public-calculatormodel",level:2},{value:"public String getValue()
",id:"public-string-getvalue",level:2},{value:"public void update(String text)
",id:"public-void-updatestring-text",level:2},{value:"public double operationAdd(double rhs, double lhs)
",id:"public-double-operationadddouble-rhs-double-lhs",level:2}];function c(e){const i={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"calculatormodeljava",children:"CalculatorModel.java"})}),"\n",(0,n.jsxs)(i.p,{children:["(generated using ",(0,n.jsx)(i.a,{href:"https://delight-im.github.io/Javadoc-to-Markdown/",children:"Javadoc to Markdown"}),")"]}),"\n",(0,n.jsx)(i.h2,{id:"public-class-calculatormodel",children:(0,n.jsx)(i.code,{children:"public class CalculatorModel"})}),"\n",(0,n.jsx)(i.p,{children:"This is the model of this MVC implementation of a calculator. It performs the functions of the calculator and keeps track of what the user has entered."}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Author:"})," Tom Bylander"]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"private-double-displayvalue",children:(0,n.jsx)(i.code,{children:"private double displayValue"})}),"\n",(0,n.jsx)(i.p,{children:"This is the numeric value of the number the user is entering, or the number that was just calculated."}),"\n",(0,n.jsx)(i.h2,{id:"private-double-internalvalue",children:(0,n.jsx)(i.code,{children:"private double internalValue"})}),"\n",(0,n.jsx)(i.p,{children:"This is the previous value entered or calculated."}),"\n",(0,n.jsx)(i.h2,{id:"private-string-displaystring",children:(0,n.jsx)(i.code,{children:"private String displayString"})}),"\n",(0,n.jsx)(i.p,{children:"This is the String corresponding to what the user. is entering"}),"\n",(0,n.jsx)(i.h2,{id:"private-string-operation",children:(0,n.jsx)(i.code,{children:"private String operation"})}),"\n",(0,n.jsx)(i.p,{children:"This is the last operation entered by the user."}),"\n",(0,n.jsx)(i.h2,{id:"private-boolean-start",children:(0,n.jsx)(i.code,{children:"private boolean start"})}),"\n",(0,n.jsx)(i.p,{children:"This is true if the next digit entered starts a new value."}),"\n",(0,n.jsx)(i.h2,{id:"private-boolean-dot",children:(0,n.jsx)(i.code,{children:"private boolean dot"})}),"\n",(0,n.jsx)(i.p,{children:"This is true if a decimal dot has been entered for the current value."}),"\n",(0,n.jsx)(i.h2,{id:"public-calculatormodel",children:(0,n.jsx)(i.code,{children:"public CalculatorModel()"})}),"\n",(0,n.jsx)(i.p,{children:"Initializes the instance variables."}),"\n",(0,n.jsx)(i.h2,{id:"public-string-getvalue",children:(0,n.jsx)(i.code,{children:"public String getValue()"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Returns:"})," the String value of what was just calculated"]}),"\n",(0,n.jsx)(i.p,{children:"or what the user is entering"}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"public-void-updatestring-text",children:(0,n.jsx)(i.code,{children:"public void update(String text)"})}),"\n",(0,n.jsx)(i.p,{children:"Updates the values maintained by the calculator based on the button that the user has just clicked."}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Parameters:"})," ",(0,n.jsx)(i.code,{children:"text"})," \u2014 is the name of the button that the user has just clicked"]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"public-double-operationadddouble-rhs-double-lhs",children:(0,n.jsx)(i.code,{children:"public double operationAdd(double rhs, double lhs)"})}),"\n",(0,n.jsxs)(i.p,{children:["Operation to add two numbers. ",(0,n.jsx)("pre",{children:" operationAdd(3,2); // should equal 5.0 "})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Parameters:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"rhs"})," \u2014 ",(0,n.jsx)(i.code,{children:"double"})," representing the right hand side of the operator"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"lhs"})," \u2014 ",(0,n.jsx)(i.code,{children:"double"})," representing the left hand side of the operator"]}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Returns:"})," ",(0,n.jsx)(i.code,{children:"double"})]}),"\n"]})]})}function u(e={}){const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},28453:(e,i,t)=>{t.d(i,{R:()=>a,x:()=>d});var l=t(96540);const n={},r=l.createContext(n);function a(e){const i=l.useContext(r);return l.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),l.createElement(r.Provider,{value:i},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/986fb218.cce7224e.js b/assets/js/986fb218.cce7224e.js
new file mode 100644
index 0000000..24b37b6
--- /dev/null
+++ b/assets/js/986fb218.cce7224e.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[9623],{30454:(e,i,t)=>{t.r(i),t.d(i,{assets:()=>o,contentTitle:()=>d,default:()=>u,frontMatter:()=>a,metadata:()=>l,toc:()=>s});const l=JSON.parse('{"id":"api-specification/calculator-model-generated","title":"CalculatorModel.java","description":"(generated using Javadoc to Markdown)","source":"@site/docs/api-specification/calculator-model-generated.md","sourceDirName":"api-specification","slug":"/api-specification/calculator-model-generated","permalink":"/docs/api-specification/calculator-model-generated","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/api-specification/calculator-model-generated.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"docsSidebar","previous":{"title":"API 1 - Courses API","permalink":"/docs/api-specification/openapi-spec"},"next":{"title":"API 1 - Swagger Petstore","permalink":"/docs/api-specification/openapi-spec-petstore"}}');var n=t(74848),r=t(28453);const a={sidebar_position:3},d="CalculatorModel.java",o={},s=[{value:"public class CalculatorModel
",id:"public-class-calculatormodel",level:2},{value:"private double displayValue
",id:"private-double-displayvalue",level:2},{value:"private double internalValue
",id:"private-double-internalvalue",level:2},{value:"private String displayString
",id:"private-string-displaystring",level:2},{value:"private String operation
",id:"private-string-operation",level:2},{value:"private boolean start
",id:"private-boolean-start",level:2},{value:"private boolean dot
",id:"private-boolean-dot",level:2},{value:"public CalculatorModel()
",id:"public-calculatormodel",level:2},{value:"public String getValue()
",id:"public-string-getvalue",level:2},{value:"public void update(String text)
",id:"public-void-updatestring-text",level:2},{value:"public double operationAdd(double rhs, double lhs)
",id:"public-double-operationadddouble-rhs-double-lhs",level:2}];function c(e){const i={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.header,{children:(0,n.jsx)(i.h1,{id:"calculatormodeljava",children:"CalculatorModel.java"})}),"\n",(0,n.jsxs)(i.p,{children:["(generated using ",(0,n.jsx)(i.a,{href:"https://delight-im.github.io/Javadoc-to-Markdown/",children:"Javadoc to Markdown"}),")"]}),"\n",(0,n.jsx)(i.h2,{id:"public-class-calculatormodel",children:(0,n.jsx)(i.code,{children:"public class CalculatorModel"})}),"\n",(0,n.jsx)(i.p,{children:"This is the model of this MVC implementation of a calculator. It performs the functions of the calculator and keeps track of what the user has entered."}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Author:"})," Tom Bylander"]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"private-double-displayvalue",children:(0,n.jsx)(i.code,{children:"private double displayValue"})}),"\n",(0,n.jsx)(i.p,{children:"This is the numeric value of the number the user is entering, or the number that was just calculated."}),"\n",(0,n.jsx)(i.h2,{id:"private-double-internalvalue",children:(0,n.jsx)(i.code,{children:"private double internalValue"})}),"\n",(0,n.jsx)(i.p,{children:"This is the previous value entered or calculated."}),"\n",(0,n.jsx)(i.h2,{id:"private-string-displaystring",children:(0,n.jsx)(i.code,{children:"private String displayString"})}),"\n",(0,n.jsx)(i.p,{children:"This is the String corresponding to what the user. is entering"}),"\n",(0,n.jsx)(i.h2,{id:"private-string-operation",children:(0,n.jsx)(i.code,{children:"private String operation"})}),"\n",(0,n.jsx)(i.p,{children:"This is the last operation entered by the user."}),"\n",(0,n.jsx)(i.h2,{id:"private-boolean-start",children:(0,n.jsx)(i.code,{children:"private boolean start"})}),"\n",(0,n.jsx)(i.p,{children:"This is true if the next digit entered starts a new value."}),"\n",(0,n.jsx)(i.h2,{id:"private-boolean-dot",children:(0,n.jsx)(i.code,{children:"private boolean dot"})}),"\n",(0,n.jsx)(i.p,{children:"This is true if a decimal dot has been entered for the current value."}),"\n",(0,n.jsx)(i.h2,{id:"public-calculatormodel",children:(0,n.jsx)(i.code,{children:"public CalculatorModel()"})}),"\n",(0,n.jsx)(i.p,{children:"Initializes the instance variables."}),"\n",(0,n.jsx)(i.h2,{id:"public-string-getvalue",children:(0,n.jsx)(i.code,{children:"public String getValue()"})}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:["\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Returns:"})," the String value of what was just calculated"]}),"\n",(0,n.jsx)(i.p,{children:"or what the user is entering"}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"public-void-updatestring-text",children:(0,n.jsx)(i.code,{children:"public void update(String text)"})}),"\n",(0,n.jsx)(i.p,{children:"Updates the values maintained by the calculator based on the button that the user has just clicked."}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Parameters:"})," ",(0,n.jsx)(i.code,{children:"text"})," \u2014 is the name of the button that the user has just clicked"]}),"\n"]}),"\n",(0,n.jsx)(i.h2,{id:"public-double-operationadddouble-rhs-double-lhs",children:(0,n.jsx)(i.code,{children:"public double operationAdd(double rhs, double lhs)"})}),"\n",(0,n.jsxs)(i.p,{children:["Operation to add two numbers. ",(0,n.jsx)("pre",{children:" operationAdd(3,2); // should equal 5.0 "})]}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Parameters:"}),"\n",(0,n.jsxs)(i.ul,{children:["\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"rhs"})," \u2014 ",(0,n.jsx)(i.code,{children:"double"})," representing the right hand side of the operator"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.code,{children:"lhs"})," \u2014 ",(0,n.jsx)(i.code,{children:"double"})," representing the left hand side of the operator"]}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(i.li,{children:[(0,n.jsx)(i.strong,{children:"Returns:"})," ",(0,n.jsx)(i.code,{children:"double"})]}),"\n"]})]})}function u(e={}){const{wrapper:i}={...(0,r.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},28453:(e,i,t)=>{t.d(i,{R:()=>a,x:()=>d});var l=t(96540);const n={},r=l.createContext(n);function a(e){const i=l.useContext(r);return l.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),l.createElement(r.Provider,{value:i},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/9ca7995a.3dc06c82.js b/assets/js/9ca7995a.3dc06c82.js
new file mode 100644
index 0000000..120cd00
--- /dev/null
+++ b/assets/js/9ca7995a.3dc06c82.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[2987],{69879:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>r,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"testing/integration-testing","title":"Integration tests","description":"Tests to demonstrate each use-case based on the use-case descriptions and the sequence diagrams. External input should be provided via mock objects and results verified via mock objects. Integration tests should not require manual entry of data nor require manual interpretation of results.","source":"@site/docs/testing/integration-testing.md","sourceDirName":"testing","slug":"/testing/integration-testing","permalink":"/docs/testing/integration-testing","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/testing/integration-testing.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":2,"frontMatter":{"sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Unit tests","permalink":"/docs/testing/unit-testing"},"next":{"title":"Acceptance test","permalink":"/docs/testing/acceptence-testing"}}');var i=n(74848),o=n(28453);const r={sidebar_position:2},a="Integration tests",c={},d=[];function u(t){const e={h1:"h1",header:"header",p:"p",...(0,o.R)(),...t.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{children:(0,i.jsx)(e.h1,{id:"integration-tests",children:"Integration tests"})}),"\n",(0,i.jsx)(e.p,{children:"Tests to demonstrate each use-case based on the use-case descriptions and the sequence diagrams. External input should be provided via mock objects and results verified via mock objects. Integration tests should not require manual entry of data nor require manual interpretation of results."})]})}function l(t={}){const{wrapper:e}={...(0,o.R)(),...t.components};return e?(0,i.jsx)(e,{...t,children:(0,i.jsx)(u,{...t})}):u(t)}},28453:(t,e,n)=>{n.d(e,{R:()=>r,x:()=>a});var s=n(96540);const i={},o=s.createContext(i);function r(t){const e=s.useContext(o);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function a(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:r(t.components),s.createElement(o.Provider,{value:e},t.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/9ca7995a.e6b739de.js b/assets/js/9ca7995a.e6b739de.js
deleted file mode 100644
index 9116fb5..0000000
--- a/assets/js/9ca7995a.e6b739de.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[2987],{69879:(t,e,n)=>{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>a,default:()=>l,frontMatter:()=>r,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"testing/integration-testing","title":"Integration tests","description":"Tests to demonstrate each use-case based on the use-case descriptions and the sequence diagrams. External input should be provided via mock objects and results verified via mock objects. Integration tests should not require manual entry of data nor require manual interpretation of results.","source":"@site/docs/testing/integration-testing.md","sourceDirName":"testing","slug":"/testing/integration-testing","permalink":"/docs/testing/integration-testing","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/testing/integration-testing.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":2,"frontMatter":{"sidebar_position":2},"sidebar":"docsSidebar","previous":{"title":"Unit tests","permalink":"/docs/testing/unit-testing"},"next":{"title":"Acceptance test","permalink":"/docs/testing/acceptence-testing"}}');var i=n(74848),o=n(28453);const r={sidebar_position:2},a="Integration tests",c={},d=[];function u(t){const e={h1:"h1",header:"header",p:"p",...(0,o.R)(),...t.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.header,{children:(0,i.jsx)(e.h1,{id:"integration-tests",children:"Integration tests"})}),"\n",(0,i.jsx)(e.p,{children:"Tests to demonstrate each use-case based on the use-case descriptions and the sequence diagrams. External input should be provided via mock objects and results verified via mock objects. Integration tests should not require manual entry of data nor require manual interpretation of results."})]})}function l(t={}){const{wrapper:e}={...(0,o.R)(),...t.components};return e?(0,i.jsx)(e,{...t,children:(0,i.jsx)(u,{...t})}):u(t)}},28453:(t,e,n)=>{n.d(e,{R:()=>r,x:()=>a});var s=n(96540);const i={},o=s.createContext(i);function r(t){const e=s.useContext(o);return s.useMemo((function(){return"function"==typeof t?t(e):{...e,...t}}),[e,t])}function a(t){let e;return e=t.disableParentContext?"function"==typeof t.components?t.components(i):t.components||i:r(t.components),s.createElement(o.Provider,{value:e},t.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/a2457c20.2a82132c.js b/assets/js/a2457c20.2a82132c.js
new file mode 100644
index 0000000..02bde02
--- /dev/null
+++ b/assets/js/a2457c20.2a82132c.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[839],{3502:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"api-specification/Intro","title":"Design Document - Part II API","description":"What should be in this section.","source":"@site/docs/api-specification/Intro.md","sourceDirName":"api-specification","slug":"/api-specification/Intro","permalink":"/docs/api-specification/Intro","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/api-specification/Intro.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":1,"frontMatter":{"sidebar_position":1,"description":"What should be in this section."},"sidebar":"docsSidebar","previous":{"title":"System Architecture","permalink":"/docs/system-architecture/Intro"},"next":{"title":"API 1 - Courses API","permalink":"/docs/api-specification/openapi-spec"}}');var o=n(74848),s=n(28453);const a={sidebar_position:1,description:"What should be in this section."},r="Design Document - Part II API",c={},d=[{value:"Purpose",id:"purpose",level:2},{value:"Requirements",id:"requirements",level:2},{value:"Previous Class Examples",id:"previous-class-examples",level:2}];function l(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",header:"header",mdxAdmonitionTitle:"mdxAdmonitionTitle",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"design-document---part-ii-api",children:"Design Document - Part II API"})}),"\n",(0,o.jsx)(t.h2,{id:"purpose",children:"Purpose"}),"\n",(0,o.jsx)(t.p,{children:"This Design Document gives the complete design of the software implementation. This information should be in structured comments (e.g. Javadoc) in the source files. We encourage the use of a documentation generation tool to generate a draft of your API that you can augment to include the following details."}),"\n",(0,o.jsx)(t.h2,{id:"requirements",children:"Requirements"}),"\n",(0,o.jsx)(t.p,{children:"In addition to the general documentation requirements the Design Document - Part II API will contain:"}),"\n",(0,o.jsx)(t.p,{children:"General review of the software architecture for each module specified in Design Document - Part I Architecture. Please include your class diagram as an important reference."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.strong,{children:"For each class define the data fields, methods."})}),"\n",(0,o.jsx)(t.p,{children:"The purpose of the class."}),"\n",(0,o.jsx)(t.p,{children:"The purpose of each data field."}),"\n",(0,o.jsx)(t.p,{children:"The purpose of each method"}),"\n",(0,o.jsx)(t.p,{children:"Pre-conditions if any."}),"\n",(0,o.jsx)(t.p,{children:"Post-conditions if any."}),"\n",(0,o.jsx)(t.p,{children:"Parameters and data types"}),"\n",(0,o.jsx)(t.p,{children:"Return value and output variables"}),"\n",(0,o.jsx)(t.p,{children:"Exceptions thrown* (PLEASE see note below for details)."}),"\n",(0,o.jsx)(t.h2,{id:"previous-class-examples",children:"Previous Class Examples"}),"\n",(0,o.jsxs)(t.p,{children:["An example of an auto-generated API specification is here (",(0,o.jsx)(t.a,{href:"https://capstone-projects-2022-fall.github.io/project-patreon-shout/docs/api-specification/api-documentation",title:"Patreon Shout API Specification",children:"Patreon Shout API Specification"})," )"]}),"\n",(0,o.jsxs)(t.p,{children:["This group developed their API documentation by hand (",(0,o.jsx)(t.a,{href:"https://capstone-projects-2022-fall.github.io/project-collabybot/docs/api-specification/class-doc",title:"Collaby Bot API Specification",children:"Collaby Bot API Specificication"})," and ",(0,o.jsx)(t.a,{href:"https://capstone-projects-2022-fall.github.io/project-attendance-face-recognition/docs/api-specification/AFR_API",children:"Attendance Face Recognition REST API"}),")"]}),"\n",(0,o.jsxs)(t.admonition,{type:"note",children:[(0,o.jsx)(t.mdxAdmonitionTitle,{}),(0,o.jsxs)(t.p,{children:['*At the top level, or where appropriate, all exceptions should be caught and an error message that is meaningful to the user generated. It is not OK to say ("xxxx has encountered a problem and will now close ',(0,o.jsx)(t.code,{children:"OK"}),'"). Error messages and recovery procedures should be documented in the README/User\u2019s Manual.']})]})]})}function p(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>r});var i=n(96540);const o={},s=i.createContext(o);function a(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/a2457c20.4982f8bf.js b/assets/js/a2457c20.4982f8bf.js
deleted file mode 100644
index 898f2fb..0000000
--- a/assets/js/a2457c20.4982f8bf.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[839],{3502:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>p,frontMatter:()=>a,metadata:()=>i,toc:()=>d});const i=JSON.parse('{"id":"api-specification/Intro","title":"Design Document - Part II API","description":"What should be in this section.","source":"@site/docs/api-specification/Intro.md","sourceDirName":"api-specification","slug":"/api-specification/Intro","permalink":"/docs/api-specification/Intro","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/api-specification/Intro.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":1,"frontMatter":{"sidebar_position":1,"description":"What should be in this section."},"sidebar":"docsSidebar","previous":{"title":"System Architecture","permalink":"/docs/system-architecture/Intro"},"next":{"title":"API 1 - Courses API","permalink":"/docs/api-specification/openapi-spec"}}');var o=n(74848),s=n(28453);const a={sidebar_position:1,description:"What should be in this section."},r="Design Document - Part II API",c={},d=[{value:"Purpose",id:"purpose",level:2},{value:"Requirements",id:"requirements",level:2},{value:"Previous Class Examples",id:"previous-class-examples",level:2}];function l(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",header:"header",mdxAdmonitionTitle:"mdxAdmonitionTitle",p:"p",strong:"strong",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"design-document---part-ii-api",children:"Design Document - Part II API"})}),"\n",(0,o.jsx)(t.h2,{id:"purpose",children:"Purpose"}),"\n",(0,o.jsx)(t.p,{children:"This Design Document gives the complete design of the software implementation. This information should be in structured comments (e.g. Javadoc) in the source files. We encourage the use of a documentation generation tool to generate a draft of your API that you can augment to include the following details."}),"\n",(0,o.jsx)(t.h2,{id:"requirements",children:"Requirements"}),"\n",(0,o.jsx)(t.p,{children:"In addition to the general documentation requirements the Design Document - Part II API will contain:"}),"\n",(0,o.jsx)(t.p,{children:"General review of the software architecture for each module specified in Design Document - Part I Architecture. Please include your class diagram as an important reference."}),"\n",(0,o.jsx)(t.p,{children:(0,o.jsx)(t.strong,{children:"For each class define the data fields, methods."})}),"\n",(0,o.jsx)(t.p,{children:"The purpose of the class."}),"\n",(0,o.jsx)(t.p,{children:"The purpose of each data field."}),"\n",(0,o.jsx)(t.p,{children:"The purpose of each method"}),"\n",(0,o.jsx)(t.p,{children:"Pre-conditions if any."}),"\n",(0,o.jsx)(t.p,{children:"Post-conditions if any."}),"\n",(0,o.jsx)(t.p,{children:"Parameters and data types"}),"\n",(0,o.jsx)(t.p,{children:"Return value and output variables"}),"\n",(0,o.jsx)(t.p,{children:"Exceptions thrown* (PLEASE see note below for details)."}),"\n",(0,o.jsx)(t.h2,{id:"previous-class-examples",children:"Previous Class Examples"}),"\n",(0,o.jsxs)(t.p,{children:["An example of an auto-generated API specification is here (",(0,o.jsx)(t.a,{href:"https://capstone-projects-2022-fall.github.io/project-patreon-shout/docs/api-specification/api-documentation",title:"Patreon Shout API Specification",children:"Patreon Shout API Specification"})," )"]}),"\n",(0,o.jsxs)(t.p,{children:["This group developed their API documentation by hand (",(0,o.jsx)(t.a,{href:"https://capstone-projects-2022-fall.github.io/project-collabybot/docs/api-specification/class-doc",title:"Collaby Bot API Specification",children:"Collaby Bot API Specificication"})," and ",(0,o.jsx)(t.a,{href:"https://capstone-projects-2022-fall.github.io/project-attendance-face-recognition/docs/api-specification/AFR_API",children:"Attendance Face Recognition REST API"}),")"]}),"\n",(0,o.jsxs)(t.admonition,{type:"note",children:[(0,o.jsx)(t.mdxAdmonitionTitle,{}),(0,o.jsxs)(t.p,{children:['*At the top level, or where appropriate, all exceptions should be caught and an error message that is meaningful to the user generated. It is not OK to say ("xxxx has encountered a problem and will now close ',(0,o.jsx)(t.code,{children:"OK"}),'"). Error messages and recovery procedures should be documented in the README/User\u2019s Manual.']})]})]})}function p(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>r});var i=n(96540);const o={},s=i.createContext(o);function a(e){const t=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/a854a899.459baefe.js b/assets/js/a854a899.459baefe.js
deleted file mode 100644
index bad7f4a..0000000
--- a/assets/js/a854a899.459baefe.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[3374],{84811:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>r,toc:()=>m});const r=JSON.parse('{"id":"requirements/system-overview","title":"System Overview","description":"","source":"@site/docs/requirements/system-overview.md","sourceDirName":"requirements","slug":"/requirements/system-overview","permalink":"/docs/requirements/system-overview","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/system-overview.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Requirements Documentation","permalink":"/docs/requirements/Intro"},"next":{"title":"System Block Diagram","permalink":"/docs/requirements/system-block-diagram"}}');var n=s(74848),i=s(28453);const o={sidebar_position:1},c="System Overview",a={},m=[];function u(e){const t={h1:"h1",header:"header",...(0,i.R)(),...e.components};return(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"system-overview",children:"System Overview"})})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(u,{...e})}):u(e)}},28453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>c});var r=s(96540);const n={},i=r.createContext(n);function o(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:o(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/a854a899.7e5f68e4.js b/assets/js/a854a899.7e5f68e4.js
new file mode 100644
index 0000000..a2ce597
--- /dev/null
+++ b/assets/js/a854a899.7e5f68e4.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[3374],{84811:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>d,frontMatter:()=>o,metadata:()=>n,toc:()=>m});const n=JSON.parse('{"id":"requirements/system-overview","title":"System Overview","description":"","source":"@site/docs/requirements/system-overview.md","sourceDirName":"requirements","slug":"/requirements/system-overview","permalink":"/docs/requirements/system-overview","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/system-overview.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"docsSidebar","previous":{"title":"Requirements Documentation","permalink":"/docs/requirements/Intro"},"next":{"title":"System Block Diagram","permalink":"/docs/requirements/system-block-diagram"}}');var r=s(74848),i=s(28453);const o={sidebar_position:1},c="System Overview",a={},m=[];function u(e){const t={h1:"h1",header:"header",...(0,i.R)(),...e.components};return(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"system-overview",children:"System Overview"})})}function d(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(u,{...e})}):u(e)}},28453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>c});var n=s(96540);const r={},i=n.createContext(r);function o(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/bafd4460.219e171a.js b/assets/js/bafd4460.219e171a.js
new file mode 100644
index 0000000..d723efa
--- /dev/null
+++ b/assets/js/bafd4460.219e171a.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[6024],{36035:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>o,default:()=>m,frontMatter:()=>a,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"requirements/features-and-requirements","title":"Features and Requirements","description":"","source":"@site/docs/requirements/features-and-requirements.md","sourceDirName":"requirements","slug":"/requirements/features-and-requirements","permalink":"/docs/requirements/features-and-requirements","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/features-and-requirements.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":4,"frontMatter":{"sidebar_position":4},"sidebar":"docsSidebar","previous":{"title":"General Requirements","permalink":"/docs/requirements/general-requirements"},"next":{"title":"Use-case descriptions","permalink":"/docs/requirements/use-case-descriptions"}}');var s=n(74848),i=n(28453);const a={sidebar_position:4},o="Features and Requirements",u={},c=[];function d(e){const t={h1:"h1",header:"header",...(0,i.R)(),...e.components};return(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"features-and-requirements",children:"Features and Requirements"})})}function m(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>o});var r=n(96540);const s={},i=r.createContext(s);function a(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/bafd4460.ef225e74.js b/assets/js/bafd4460.ef225e74.js
deleted file mode 100644
index 45d5c86..0000000
--- a/assets/js/bafd4460.ef225e74.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[6024],{36035:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>o,default:()=>m,frontMatter:()=>a,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"requirements/features-and-requirements","title":"Features and Requirements","description":"","source":"@site/docs/requirements/features-and-requirements.md","sourceDirName":"requirements","slug":"/requirements/features-and-requirements","permalink":"/docs/requirements/features-and-requirements","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/requirements/features-and-requirements.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":4,"frontMatter":{"sidebar_position":4},"sidebar":"docsSidebar","previous":{"title":"General Requirements","permalink":"/docs/requirements/general-requirements"},"next":{"title":"Use-case descriptions","permalink":"/docs/requirements/use-case-descriptions"}}');var s=n(74848),i=n(28453);const a={sidebar_position:4},o="Features and Requirements",u={},c=[];function d(e){const t={h1:"h1",header:"header",...(0,i.R)(),...e.components};return(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"features-and-requirements",children:"Features and Requirements"})})}function m(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},28453:(e,t,n)=>{n.d(t,{R:()=>a,x:()=>o});var r=n(96540);const s={},i=r.createContext(s);function a(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/c28e829f.2f7fd9e6.js b/assets/js/c28e829f.2f7fd9e6.js
new file mode 100644
index 0000000..bf584a5
--- /dev/null
+++ b/assets/js/c28e829f.2f7fd9e6.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1578],{44163:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>l,default:()=>a,frontMatter:()=>i,metadata:()=>o,toc:()=>d});const o=JSON.parse('{"id":"development-plan/development-environment","title":"Development Environment","description":"","source":"@site/docs/development-plan/development-environment.md","sourceDirName":"development-plan","slug":"/development-plan/development-environment","permalink":"/docs/development-plan/development-environment","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/development-plan/development-environment.md","tags":[],"version":"current","lastUpdatedBy":"Ian Applebaum","sidebarPosition":4,"frontMatter":{"sidebar_position":4},"sidebar":"docsSidebar","previous":{"title":"Schedule","permalink":"/docs/development-plan/schedule"},"next":{"title":"Version Control","permalink":"/docs/development-plan/version-control"}}');var r=t(74848),s=t(28453);const i={sidebar_position:4},l="Development Environment",p={},d=[];function c(e){const n={h1:"h1",header:"header",...(0,s.R)(),...e.components};return(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"development-environment",children:"Development Environment"})})}function a(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>l});var o=t(96540);const r={},s=o.createContext(r);function i(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/c28e829f.c40f8cbc.js b/assets/js/c28e829f.c40f8cbc.js
deleted file mode 100644
index 8c1a5f5..0000000
--- a/assets/js/c28e829f.c40f8cbc.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[1578],{44163:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>p,contentTitle:()=>l,default:()=>a,frontMatter:()=>i,metadata:()=>o,toc:()=>d});const o=JSON.parse('{"id":"development-plan/development-environment","title":"Development Environment","description":"","source":"@site/docs/development-plan/development-environment.md","sourceDirName":"development-plan","slug":"/development-plan/development-environment","permalink":"/docs/development-plan/development-environment","draft":false,"unlisted":false,"editUrl":"https://github.com/ApplebaumIan/projects-in-computer-science/edit/main/documentation/docs/development-plan/development-environment.md","tags":[],"version":"current","lastUpdatedBy":"Ian Tyler Applebaum","sidebarPosition":4,"frontMatter":{"sidebar_position":4},"sidebar":"docsSidebar","previous":{"title":"Schedule","permalink":"/docs/development-plan/schedule"},"next":{"title":"Version Control","permalink":"/docs/development-plan/version-control"}}');var r=t(74848),s=t(28453);const i={sidebar_position:4},l="Development Environment",p={},d=[];function c(e){const n={h1:"h1",header:"header",...(0,s.R)(),...e.components};return(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"development-environment",children:"Development Environment"})})}function a(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>l});var o=t(96540);const r={},s=o.createContext(r);function i(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/c4f5d8e4.bfa36101.js b/assets/js/c4f5d8e4.bfa36101.js
new file mode 100644
index 0000000..1aa5d4c
--- /dev/null
+++ b/assets/js/c4f5d8e4.bfa36101.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunktu_cis_4398_docs_template=self.webpackChunktu_cis_4398_docs_template||[]).push([[2634],{20087:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>c,default:()=>h,frontMatter:()=>i,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"type":"mdx","permalink":"/projects","source":"@site/src/pages/projects.mdx","description":"Projects","frontMatter":{},"unlisted":false}');var r=a(74848),l=a(28453);const i={},c=void 0,s={},d=[{value:"Projects",id:"projects",level:3}];function o(e){const t={h3:"h3",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h3,{id:"projects",children:"Projects"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Project"}),(0,r.jsx)(t.th,{children:"Description"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)(t.strong,{children:"Feedstack"}),(0,r.jsx)("br",{}),"Stephen MacNeil"]}),(0,r.jsx)(t.td,{children:"This project aims to enhance the way feedback is given to learners, particularly on resumes, by linking feedback with design principles such as consistency and specificity. It utilizes ChatGPT to create chapters that help learners understand and apply feedback effectively."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)(t.strong,{children:"GitHub Copilot Clone for Education"}),(0,r.jsx)("br",{}),"Stephen MacNeil"]}),(0,r.jsx)(t.td,{children:"The goal is to develop a GitHub Copilot clone that functions similarly but includes rich logging capabilities to monitor user behavior. This project addresses the problem of novices misusing AI coding assistants by providing educational interventions when mistakes are made."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)(t.strong,{children:"AAC Play"}),(0,r.jsx)("br",{}),"Cindy Zastudil"]}),(0,r.jsx)(t.td,{children:"This project focuses on enhancing augmentative and alternative communication (AAC) devices for children. It aims to integrate games that encourage social interaction while also providing necessary communication tools for AAC users, potentially reducing social isolation."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)(t.strong,{children:"Piggyback Learning"}),(0,r.jsx)("br",{}),"Rahad Arman Nabid"]}),(0,r.jsx)(t.td,{children:"The project involves creating tools to make educational YouTube videos more engaging for children. These tools would inject interactive quizzes and learning materials into videos to improve structured learning experiences."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)(t.strong,{children:"Story Builder Project"}),(0,r.jsx)("br",{}),"Rahad Arman Nabid"]}),(0,r.jsx)(t.td,{children:"This project proposes the use of AI agents to automate story creation. It envisions a system where users can generate agents that create story outlines and chapters, which are then voted on for selection. The process is inspired by crowdsourcing but uses AI agents instead of human writers. The system also allows for user edits and aims to create a full story autonomously. The project draws inspiration from existing research on collaborative writing to develop a new method using AI technology."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)(t.strong,{children:"3D Printer Security"}),(0,r.jsx)("br",{}),"Daniel Collins"]}),(0,r.jsx)(t.td,{children:"The project involves developing a security tool for 3D printing systems used by the U.S. Navy and Marine Corps. The goal is to create a \u201clast mile\u201d security solution that scans the manufacturing files either before or as they are being sent to the 3D printer. This tool should detect and prevent malicious activities such as wasting materials, overheating, or damaging the printer through unauthorized commands."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)(t.strong,{children:"Bioinformatics Software Tutorial Supporting Chatbot"}),(0,r.jsx)("br",{}),"Hannah Kim"]}),(0,r.jsx)(t.td,{children:"This project aims to develop software that uses AI to facilitate learning about bioinformatics. It involves creating a chatbot with retrieval-augmented generation (RAG) capabilities, which can refer to a database to answer user questions. Key features include a customized tutorial experience, a clean web application interface, chat history, use of a free API key to keep costs low, and the ability to admit when it doesn\u2019t know an answer rather than providing incorrect information. This project highlights the potential for interdisciplinary collaboration and overcoming barriers in bioinformatics education."})]})]})]})]})}function h(e={}){const{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},59132:(e,t,a)=>{a.d(t,{A:()=>i});var n,r=a(96540);function l(){return l=Object.assign?Object.assign.bind():function(e){for(var t=1;tAn example of an auto-generated API specification is here (Patreon Shout API Specification )
This group developed their API documentation by hand (Collaby Bot API Specificication and Attendance Face Recognition REST API)
-*At the top level, or where appropriate, all exceptions should be caught and an error message that is meaningful to the user generated. It is not OK to say ("xxxx has encountered a problem and will now close OK
"). Error messages and recovery procedures should be documented in the README/User’s Manual.
*At the top level, or where appropriate, all exceptions should be caught and an error message that is meaningful to the user generated. It is not OK to say ("xxxx has encountered a problem and will now close OK
"). Error messages and recovery procedures should be documented in the README/User’s Manual.