-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f5c3f93
commit 42ae0b4
Showing
1 changed file
with
71 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,84 @@ | ||
# HEHEHAHA todo | ||
<!--- workspace { | ||
#Structurizr DLS | ||
workspace { | ||
model { | ||
user = person "User" | ||
softwareSystem = softwareSystem "UniBasement" { | ||
ui = container "User Interface" { | ||
user -> this "Uses" | ||
} | ||
webapp = container "Web Api" { | ||
ui -> this "Uses" | ||
user = person "Student" "A user of my website" | ||
group "Unit Basement" { | ||
auth0SoftwareSystem = softwareSystem "Auth0" { | ||
description "Verify a user's identity before giving them access to the website" | ||
tags "Dependency" | ||
} | ||
uniBasementSoftwareSystem = softwareSystem "Uni Basement" { | ||
description "The actual project" | ||
webApp = container "Web Application" { | ||
description "Delivers the static content and the JavaScript application" | ||
technology "TypeScript, HTML, TailwindCSS" | ||
} | ||
restApi = container "Application Backend" { | ||
description "Provides backend logic for the website" | ||
technology "TypeScript & TypeORM" | ||
} | ||
database = container "Database" { | ||
description "Stores course information, course ratings, exams & questions" | ||
technology "PostgreSQL" | ||
tags "Database" | ||
} | ||
} | ||
container "Database" { | ||
webapp -> this "Reads from and writes to" | ||
} | ||
} | ||
} | ||
uniBasementSoftwareSystem -> auth0SoftwareSystem "Authenticate Users" | ||
webApp -> restApi "Send Messages" "Https" | ||
restApi -> database "Queries & Updates" "TypeORM" | ||
user -> uniBasementSoftwareSystem "Search, Learn, Answer Questions" | ||
} | ||
|
||
views { | ||
systemContext softwareSystem { | ||
systemContext uniBasementSoftwareSystem { | ||
description "Context diagram for the Mailman Suite." | ||
include * | ||
autolayout lr | ||
autoLayout | ||
} | ||
|
||
container softwareSystem { | ||
container uniBasementSoftwareSystem { | ||
description "Container diagram for the Mailman Suite." | ||
include * | ||
autolayout lr | ||
autoLayout | ||
} | ||
|
||
theme default | ||
} | ||
component restAPI "restAPI_diagram" { | ||
include * | ||
autoLayout | ||
} | ||
styles { | ||
element "Person" { | ||
shape Person | ||
background #bae1ff | ||
color #000000 | ||
} | ||
element "Container" { | ||
shape RoundedBox | ||
background #baffc9 | ||
color #000000 | ||
} | ||
element "Dependency" { | ||
shape RoundedBox | ||
background #ffdfba | ||
color #000000 | ||
} | ||
|
||
} ---> | ||
element "Database" { | ||
shape Cylinder | ||
background #B8D8FF | ||
color #000000 | ||
} | ||
element browser { | ||
shape WebBrowser | ||
background #b3deff | ||
/* colour is text colour. */ | ||
colour #000000 | ||
} | ||
} | ||
} | ||
} | ||
# System Context Diagram | ||
![image](https://github.com/tristanduncombe/UniBasement/assets/105094182/80ab5877-186a-427b-ba01-9388ef963f6b) | ||
# Container Diagram |