Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/analysis/nouns-and-verbs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Nouns and Verbs Analysis

## Entities
- App
- verbs: load, start, close, refresh
- Page
- verbs: display, transition, update
Comment on lines +4 to +7

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Admittedly, I am very much not a front end developer. Would the concepts of "App" and "Page" be entities that are handled by your framework? I'm questioning if these more belong in the System/Technical category.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

App and page are usually considered technical UI constructs rather than domain entities, because they only exist due to the framework and not the problem space itself.

That's why I placed them in the System/Technical category, they're important for implementation, but they don't represent real domain concepts the system is modeling.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see them listed under the Entity category -- they can be removed from there, and their skeleton classes can be removed. It's okay in this analysis if you don't find any Entity level classes. You have a couple of roles; those will end up being classes, probably. Otherwise, good work

- ToastNotification
- verbs: create, show, fade, remove
- Overlay
- verbs: activate, deactivate, flash
- Frame (MainFrame)
- verbs: render, navigate, initialize

## Roles/Actors
- User
- verbs: click, navigate, open app, trigger action
- System
- verbs: notify, load resources, manage state

## Attributes
- title
- message
- duration
- status
- src (page source)
- isActive
- type (toast type)

## System/Technical
- iframe
- DOM element
- event listener
- CSS class
- script file
- container element
10 changes: 10 additions & 0 deletions src/App.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
export class App {
constructor(name) {
this.name = name;
}

load() {}
start() {}
close() {}
refresh() {}
}
9 changes: 9 additions & 0 deletions src/MainFrame.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export class MainFrame {
constructor(iframeElement) {
this.iframeElement = iframeElement;
}

render() {}
navigate(src) {}
initialize() {}
}
9 changes: 9 additions & 0 deletions src/Overlay.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export class Overlay {
constructor() {
this.isActive = false;
}

activate() {}
deactivate() {}
flash() {}
}
9 changes: 9 additions & 0 deletions src/Page.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export class Page {
constructor(src) {
this.src = src;
}

display() {}
transition() {}
update() {}
}
12 changes: 12 additions & 0 deletions src/ToastNotification.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
export class ToastNotification {
constructor(message, type, duration) {
this.message = message;
this.type = type;
this.duration = duration;
}

create() {}
show() {}
fade() {}
remove() {}
}