Kaynağa Gözat

:pencil: added some frontend notes

tags/0.0.1
TOJ 4 yıl önce
ebeveyn
işleme
e9d0672e78
1 değiştirilmiş dosya ile 57 ekleme ve 0 silme
  1. 57
    0
      docs/routes.md

+ 57
- 0
docs/routes.md Dosyayı Görüntüle

@@ -0,0 +1,57 @@
1
+# Frontend System Breakdown
2
+Break down of the different sections of the frontend application
3
+
4
+## Application Areas
5
+
6
+### API Handler
7
+Use the built-in browser fetch() API and syncronous functions to retrieve data.
8
+Data is fed to the `entity-screener` for validation
9
+
10
+### Entity Service and Screener
11
+Uses Joi() to validate outgoing and incoming entites.
12
+Take in parsed database data and output validated objects
13
+Entities are fed to the appropriate `vuex-store` `module`
14
+
15
+### Vuex Store
16
+Retrieves data from `entity-screener` and stores it for global access
17
+Prepares data *output* for presentation and ease-of-access before sending to components
18
+Prepares data *input* for save-ability before sending to `entity-screener`
19
+
20
+### Components
21
+Vue components to actually display data
22
+
23
+## Component Hierarchy
24
+```
25
+Window
26
+|- Global Navigation
27
+|- - Account Control Modal
28
+|- - - Edit Profile
29
+|- - - - Back
30
+|- - - - Edit Photos
31
+|- - - - - Back
32
+|- - - Edit Survey
33
+|- - - - Back
34
+|- - - Search Settings
35
+|- - - - Max-Distance | Remote
36
+|- - - - Part-time | Full-time
37
+|- - - - Current Location
38
+|- - - - - Back
39
+|- - - - Back
40
+|- - - My Account Settings
41
+|- - - - Back
42
+|- Matches
43
+|- - Group (Chat)
44
+|- - - Reveal
45
+|- - - - Back
46
+|- - - Group Settings
47
+|- - - - Leave
48
+|- - - - - OK
49
+|- - - - - CANCEL
50
+|- - - - Mute
51
+|- - - - Other Profile Link
52
+|- - - - - Back
53
+|- Browse Profiles
54
+|- - Match
55
+|- - Hide
56
+|- - Search Settings (see above)
57
+```

Loading…
İptal
Kaydet