📝 Add readme

pull/1/head
Alexis Drai 2 years ago
parent 69bb253d48
commit 63b3e936a3

@ -0,0 +1,36 @@
# Oh the things you'll do
## Model
The model will include Projects and Tasks. A Project owns a collection of Tasks (but Tasks can exist outside of projects too),
and a Project has a title. A Task has a title, an optional description, and an integer priority level between 0 and 3, zero being critical.
```mermaid
classDiagram
class Project {
+String title
+List<Task> tasks
}
class Task {
+String title
+String description
+int priority
}
Project --> "*" Task
```
## View
There will be a collection of projects on the home page. Clicking on a project will navigate the user to the project detail page,
where they will find the project title on top and a collection of tasks. Clicking on a task will navigate the user to the task detail page,
where they will find the task title, the task description if any, and the task priority represented with a label of a certain color next to
the words 'priority X' where X is the priority level.
```mermaid
graph TB
A[Home Page] --> B[Project Detail Page]
B --> C[Task Detail Page]
```
Loading…
Cancel
Save