Merge pull request #55 from IUS-CS/byoungWork

Byoung work

doc/ARCHITECTURE.md

@@ -0,0 +1,31 @@
+# CrimsonSoldiersWebApp
+**Software Architecture Document**  
+**Version 1.0**  
+-----------------------------------
+
+## Introduction and Purpose
+This document provides a high-level overview of the application's architecture, the use cases supported and components that have been selected to best achieve them. 
+
+## Architecture Overview 
+
+In our system, the user sends requests over HTTPS to an Angular front-end framework. This angular application then interfaces with our web API in order to access the SQL database wich is hosted on an Azure server.
+
+![System Flow Diagram](https://github.com/IUS-CS/s20-project-crimson-soldiers/blob/byoungWork/doc/System%20flow%20diagram.JPG)
+
+## Use-Case View
+1. Actors  
+Our webapp contains 2 major use cases:
+    - Seeing all on-campus services
+    - Finding contact information for a specific service
+![Use-Case Diagram](https://github.com/IUS-CS/s20-project-crimson-soldiers/blob/byoungWork/doc/use-case.png)
+2. Use Cases  
+
+
+## Service View 
+1. Repository
+
+2. Services
+
+
+
+

doc/architecture.md

@@ -1,27 +1,26 @@
-# CrimsonSoldiersWebApp 
-**Software Architecture Document** <br />
-**Version 1.0** <br />
-
+# CrimsonSoldiersWebApp
+**Software Architecture Document**  
+**Version 1.0**  
+-----------------------------------
 
 ## Introduction and Purpose
 This document provides a high-level overview of the application's architecture, the use cases supported and components that have been selected to best achieve them. 
 
 ## Architecture Overview 
-(add system diagram flow and description)
-
-## Use-Case View
-1. Actors <br />
-(description and diagram to be added)
-
-2. Use Cases  <br />
-(list of use cases with description to be added)
-
-## Service View 
-1. Repository <br />
-...
 
-2. Services  <br />
+In our system, the user sends requests over HTTPS to an Angular front-end framework. This angular application then interfaces with our web API in order to access the SQL database wich is hosted on an Azure server.
 
+![System Flow Diagram](https://github.com/IUS-CS/s20-project-crimson-soldiers/blob/byoungWork/doc/System%20flow%20diagram.JPG)
 
+## Use-Case View  
+![Use-Case Diagram](https://github.com/IUS-CS/s20-project-crimson-soldiers/blob/byoungWork/doc/use-case.png)  
+1. Actors  
+Our webapp contains 2 major use cases:
+    - Listing all on-campus services
+    - Finding additional information for a specific service
+    - Searching
+2. Use Cases  
+    - View information
+        Short description: This use case allows users to look at and gather information on the various services offered across campus. This includes getting additional information from a popup dialog box. THe actor of this use case is the end consumer of this webapp.
 
 

doc/designpatterns.md

@@ -0,0 +1,4 @@
+We are utilizing a Singleton to get requested information from the database to the end user, this is because we want one set of information for all users.  
+The Command design pattern allows us to take HTTPS requests and take some action on them.  
+Dependency injection separates the creation of the services away from the client and onto the webapp.  
+Repositories allow us to abstract the queries to the database from the request created by the user.