-
Notifications
You must be signed in to change notification settings - Fork 0
CPW-207 Assignment 3 Alex #56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
SuperGamer001
wants to merge
5
commits into
main
Choose a base branch
from
CPW-207-Assignment-3-Alex
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
6588915
Added 3/4 of the crc card
SuperGamer001 f7a3cbf
Added Notifications to CRC Cards
SuperGamer001 c0b6911
(COPILOT REVIEW EDITS)
SuperGamer001 748c104
Added Features and Usecases file
SuperGamer001 2995fab
Fix typos in use case descriptions
SuperGamer001 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| ## Conversation | ||
|
|
||
| **Responsibilities** | ||
| - Holds and receives messages sent by participants | ||
| - Maintains relationships between messages, their replies, and attachments | ||
| - Coordinates with read status tracking to determine which message each user last read. | ||
|
|
||
| **Collaborators** | ||
| - User | ||
| - Message | ||
| - WebSocket | ||
|
|
||
|
|
||
| ## WebSocket | ||
|
|
||
| **Responsibilities** | ||
| - Updates users in real time when a message, letter, invite, etc. shows up. | ||
| - Handles real-time chat events such as typing indicators and read status updates. | ||
|
|
||
| **Collaborators** | ||
| - User | ||
| - Conversation | ||
| - Notification (Inbox) | ||
|
|
||
|
|
||
| ## Message | ||
|
|
||
| **Responsibilities** | ||
| - Holds text info on the current message | ||
| - Keeps track of who sent the message and the date when it was sent | ||
|
|
||
| **Collaborators** | ||
| - Conversation | ||
| - User | ||
|
|
||
|
|
||
| ## Notification (Inbox) | ||
|
|
||
| **Responsibilities** | ||
| - Contains information about what's in the message | ||
| - Tracks who sent it and when | ||
| - Holds any associated package content or additional data | ||
|
|
||
| **Collaborators** | ||
| - User | ||
| - Conversation | ||
| - Friend | ||
|
|
||
|
|
||
| ## Friend | ||
|
|
||
| **Responsibilities** | ||
| - Represents a friendship relationship between users | ||
| - Stores friendship status and metadata (for example, when the friendship was created) | ||
| - Supports friend-related actions such as sending and responding to friend requests | ||
|
|
||
| **Collaborators** | ||
| - User | ||
| - Notification (Inbox) | ||
| - Conversation |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| # Features and Use Cases | ||
|
|
||
| ## Features | ||
| - Register | ||
| - Maintain WS connections | ||
| - Online Activities | ||
| - Inbox Messages | ||
| - Game Library | ||
| - Search | ||
| - Friends | ||
| - Achievement system | ||
| - Toast Notifications | ||
|
|
||
| ... | ||
|
|
||
| ## Brief Use Cases | ||
|
|
||
| ### UC1: User creates an account | ||
| - Primary Actor: New user | ||
| - Goal: User successfully creates and registers his account. | ||
|
|
||
| ### UC2: User plays a game | ||
| - Primary Actor: User | ||
| - Goal: User opens an available game and plays. | ||
|
|
||
| ### UC3: User plays online | ||
| - Primary Actor: Registered User | ||
| - Goal: User connects to online services and plays online game. | ||
|
|
||
| ### UC4: System sends an inbox letter to user | ||
| - Primary Actor: System | ||
| - Goal: System sends a letter to the user's inbox | ||
|
|
||
| ### UC5: System alerts user of achievement | ||
| - Primary Actor: System | ||
| - Goal: System alerts user when he has completed an achievement. | ||
|
|
||
| ### UC6: User views the Game Library | ||
| - Primary Actor: User | ||
| - Goal: User receives the site's library of games | ||
|
|
||
| ### UC7: User searches for a specific game, genre, etc. | ||
| - Primary Actor: User | ||
| - Goal: User receives the results of his search | ||
|
|
||
| ### UC8: User becomes friends with another user | ||
| - Primary Actor: Registered User | ||
| - Goal: The registered user becomes friends with another user and can chat and play online together. | ||
|
|
||
|
|
||
|
|
||
| ... | ||
|
|
||
| ## Use Case Traceability | ||
|
|
||
| | Use Case | Feature(s) | | ||
| |---|---| | ||
| | UC1: User creates an account | Register | | ||
| | UC2: User plays a game | Game Library, WS connections | | ||
| | UC3: User plays online | Register, Online Activities, Game Library, WS connections | | ||
| | UC4: System sends an inbox letter to user | Register, Inbox Messages | | ||
| | UC5: System alerts user of achievement | Register, Achievement system, Toast Notifications | | ||
| | UC6: User views the Game Library | Game Library | | ||
| | UC7: User searches for a specific game, genre, etc. | Game Library, Search | | ||
| | UC8: User becomes friends with another user | Register, Online Activities, Friends | | ||
| ... | ||
|
|
||
| ## Use Case Diagram | ||
| Here is my diagram built with PlantUML (AI assisted, so it might not look the greatest) | ||
|
|
||
|  | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good list that could use just a bit more detail. For example -- Register. Register for what? Search for what? If you told someone you were working on the "Friends" feature, would they really know what you meant?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did we have to describe the features as we listed them out? 🤔
(Register User, Search Content, and I'm quite sure that they would know what I mean since it's common to have friend features 👍👍)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You don't have to give a sub-description. This is just an improvement suggestion for how to name features to be more clear.