Преглед изворни кода

:pencil: adding docs on how some process works

tags/0.0.1
TOJ пре 4 година
родитељ
комит
531c5a3da2
3 измењених фајлова са 167 додато и 0 уклоњено
  1. 57
    0
      docs/processes/login.md
  2. 53
    0
      docs/processes/match.md
  3. 57
    0
      docs/processes/survey.md

+ 57
- 0
docs/processes/login.md Прегледај датотеку

@@ -0,0 +1,57 @@
1
+# Process: Login
2
+
3
+Process to `login` from the top of the stack to the bottom
4
+
5
+## Request
6
+
7
+### Frontend
8
+```mermaid
9
+flowchart LR
10
+    a(login form component)-->|calls|b(login service)
11
+    b{{login service}}-->|fetch|API
12
+    API-->c(/login user route)
13
+```
14
+
15
+### Backend
16
+
17
+```mermaid
18
+flowchart LR
19
+    c(/login user route)-->|calls|d{{backend user service}}
20
+    d{{backend user service}}-.->e(login)
21
+    d{{backend user service}}-.->f(createToken)
22
+    e(login)-.->g{{backend user mode}}
23
+    f(createToken)-.->g{{backend user model}}
24
+    g{{backend user model}}<-->|schwifty model|h((DB))
25
+```
26
+
27
+
28
+## Fulfillment
29
+
30
+### Backend
31
+
32
+```mermaid
33
+flowchart LR
34
+    h((DB))<-->|schwifty model|g{{backend user model}}
35
+    g{{backend user model}}-->d{{backend user service}}
36
+    d{{backend user service}}-->c(/login user route)
37
+```
38
+
39
+### Frontend
40
+
41
+```mermaid
42
+flowchart LR
43
+    c(/login user route)-->API-->b{{login service}}
44
+    b{{login service}}-->a(login form component)
45
+```
46
+
47
+## Forward & Complete Request
48
+
49
+### Store State
50
+```mermaid
51
+flowchart LR
52
+    a(login form component)-->b{{login service}}
53
+    b{{login service}}-.->z(storeToken)
54
+    z(storeToken)--->v{{vue router}}
55
+    v{{vue router}}-.->y(forward to /matches)
56
+    z(storeToken)-.->x(fetch profiles)-->w{{profile service}}-->u(API)
57
+```

+ 53
- 0
docs/processes/match.md Прегледај датотеку

@@ -0,0 +1,53 @@
1
+# Process: Match
2
+
3
+Process to attempt `match` from a list of profile cards
4
+
5
+## Request
6
+
7
+### Frontend
8
+```mermaid
9
+flowchart LR
10
+    a(profile card component)-->|calls|b(match service)
11
+    b{{match service}}-->|fetch|API
12
+    API-->c(/<profile_id>/join route)
13
+```
14
+
15
+### Backend
16
+
17
+```mermaid
18
+flowchart LR
19
+    c(/<profile_id>/join route)-->|calls|d{{backend membership service}}
20
+    d{{backend membership service}}-.->e(joinGrouping)
21
+    e(joinGrouping)-.->g{{backend membership model}}
22
+    g{{backend membership model}}<-->|schwifty model|h((DB))
23
+```
24
+
25
+
26
+## Fulfillment
27
+
28
+### Backend
29
+
30
+```mermaid
31
+flowchart LR
32
+    h((DB))<-->|schwifty model|g{{backend membership model}}
33
+    g{{backend membership model}}-->d{{backend membership service}}
34
+    d{{backend membership service}}-->c(/<profile_id>/join route)
35
+```
36
+
37
+### Frontend
38
+
39
+```mermaid
40
+flowchart LR
41
+    c(/<profile_id>/join route)-->API-->b{{match service}}
42
+    b{{match service}}-->a(profile card component)
43
+```
44
+
45
+## Forward & Complete Request
46
+
47
+### Store State
48
+```mermaid
49
+flowchart LR
50
+    a(profile card component)-->b{{match service}}
51
+    b{{match service}}-.->z(storeGroupings)
52
+    z(storeGroupings)-.->y(forward to /matches/<profile_id>)
53
+```

+ 57
- 0
docs/processes/survey.md Прегледај датотеку

@@ -0,0 +1,57 @@
1
+# Process: Survey
2
+
3
+Complete `survey` and score answers to create `matchQueue`
4
+
5
+## Request
6
+
7
+### Frontend
8
+```mermaid
9
+flowchart LR
10
+    a(survey component)-->|calls|b(survey service)
11
+    b{{survey service}}-->|fetch|API
12
+    API-->c(/<profile_id>/save route)
13
+```
14
+
15
+### Backend
16
+
17
+```mermaid
18
+flowchart LR
19
+    c(/<profile_id>/save route)-->|calls|d{{backend survey service}}
20
+    c(/<profile_id>/save route)-->|calls|k{{backend profile service}}
21
+    d{{backend survey service}}-.->e(saveResponses)
22
+    k{{backend profile service}}-.->l(scoreAll)
23
+    e(saveResponses)-.->g{{backend response model}}
24
+    l(scoreAll)-.->m{{backend matchQueue model}}
25
+    g{{backend response model}}<-->|schwifty model|h((DB))
26
+    m{{backend matchQueue model}}<-->|schwifty model|h((DB))
27
+```
28
+
29
+
30
+## Fulfillment
31
+
32
+### Backend
33
+
34
+```mermaid
35
+flowchart LR
36
+    h((DB))<-->|schwifty model|g{{backend matchQueue model}}
37
+    g{{backend matchQueue model}}-->d{{backend machQueue service}}
38
+    d{{backend matchQueue service}}-->c(/<profile_id>/matches route)
39
+```
40
+
41
+### Frontend
42
+
43
+```mermaid
44
+flowchart LR
45
+    c(/<profile_id>/matches route)-->API-->b{{match service}}
46
+    b{{match service}}-->a(matches component)
47
+```
48
+
49
+## Forward & Complete Request
50
+
51
+### Store State
52
+```mermaid
53
+flowchart LR
54
+    a(matches component)-->b{{survey service}}
55
+    b{{match service}}-.->z(storeMatchQueue)
56
+    z(storeMatchQueue)-.->y(forward to /matches/<profile_id>)
57
+```

Loading…
Откажи
Сачувај