commit 515e9d94d4df05a98b642395908f35ad9fb8c55a Author: Tara Wilson Date: Tue Nov 26 16:45:44 2024 -0500 Starting project diff --git a/README.md b/README.md new file mode 100644 index 0000000..73184ac --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Ticket System + +An application to handle the ticketing of an event for a small organization. + +## Tech Stack + +* [ASP.Net](https://dotnet.microsoft.com/en-us/apps/aspnet) + * [QRCoder](https://github.com/codebude/QRCoder) +* [Angular](https://angular.dev) + * [Tachyons](https://tachyons.io) + * [zxing](https://www.npmjs.com/package/@zxing/ngx-scanner) +* [SQLite](https://www.sqlite.org/index.html) + +## Design + +All charts are made with [mermaid](https://mermaid.js.org/intro/). diff --git a/assets/pso-logo.png b/assets/pso-logo.png new file mode 100644 index 0000000..fe4967e Binary files /dev/null and b/assets/pso-logo.png differ diff --git a/diagrams/class-diagrams.md b/diagrams/class-diagrams.md new file mode 100644 index 0000000..2156cb6 --- /dev/null +++ b/diagrams/class-diagrams.md @@ -0,0 +1,39 @@ +# Class Diagram + +```mermaid +classDiagram +Ticket +Event +Patron +Address +Order + +Ticket : Guid Id +Ticket : int Seats +Ticket : DateTime Date +Ticket : Patron Patron + +Event : Guid Id +Event : String Title +Event : String Description +Event : DateTime Date +Event : Array Tickets + +Patron : Guid Id +Patron : String EmailAddress +Patron : String PhoneNumber +Patron : Address Address + +Address : Guid Id +Address : String StreetAddressOne +Address : String StreetAddressTwo +Address : String City +Address : String State +Address : String ZipCode + +Order : Guid Id +Order : Patron Patron +Order : Array Tickets + +Event o-- Ticket : X Tickets +``` diff --git a/diagrams/order-lookup.md b/diagrams/order-lookup.md new file mode 100644 index 0000000..0929246 --- /dev/null +++ b/diagrams/order-lookup.md @@ -0,0 +1,12 @@ +# Order Lookup + +```mermaid +sequenceDiagram +participant UI +participant API +participant DB +UI->>API: Order Id +API->>DB: Order Id +DB->>API: Order Returned +API->>UI: Order Details Returned +``` diff --git a/diagrams/ticket-minting.md b/diagrams/ticket-minting.md new file mode 100644 index 0000000..8194d1e --- /dev/null +++ b/diagrams/ticket-minting.md @@ -0,0 +1,14 @@ +# Ticket Minting + +```mermaid +sequenceDiagram +participant UI +participant API +participant DB +UI->>API: Mint Ticket(s) Request +API->>DB: Get Ticket Ids +DB->>DB: IDs Assigned +DB->>API: IDs Returned +API->>API: QR Codes Generated +API->>UI: Code Returned, Email Sent +``` diff --git a/diagrams/ticket-verification.md b/diagrams/ticket-verification.md new file mode 100644 index 0000000..3bcb861 --- /dev/null +++ b/diagrams/ticket-verification.md @@ -0,0 +1,29 @@ +# Ticket Verification + +## Happy Path + +```mermaid +sequenceDiagram +participant UI +participant API +participant DB + +UI ->> API: Decoded Ticket Id from QR Code +API ->> DB: Query DB with Id +DB ->> API: Found Ticket Info +API ->> UI: Tickets Found, Admit X Seats +``` + +## Negative Path + +```mermaid +sequenceDiagram +participant UI +participant API +participant DB + +UI ->> API: Decoded Ticket Id from QR Code +API ->> DB: Query DB with Id +DB ->> API: None Found +API ->> UI: Ticket Not Found +```