-
Notifications
You must be signed in to change notification settings - Fork 0
/
ui_documentation.html
493 lines (483 loc) · 18.6 KB
/
ui_documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2022-07-22 Fri 20:15 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Documentation of the Flight System's Front-End</title>
<meta name="author" content="Lucio Sauer" />
<meta name="generator" content="Org Mode" />
<style>
#content { max-width: 60em; margin: auto; }
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #e6e6e6;
border-radius: 3px;
background-color: #f2f2f2;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: auto;
}
pre.src:before {
display: none;
position: absolute;
top: -8px;
right: 12px;
padding: 3px;
color: #555;
background-color: #f2f2f299;
}
pre.src:hover:before { display: inline; margin-top: 14px;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-authinfo::before { content: 'Authinfo'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.equation-container {
display: table;
text-align: center;
width: 100%;
}
.equation {
vertical-align: middle;
}
.equation-label {
display: table-cell;
text-align: right;
vertical-align: middle;
}
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
</style>
</head>
<body>
<div id="content" class="content">
<h1 class="title">Documentation of the Flight System’s Front-End</h1>
<div id="table-of-contents" role="doc-toc">
<h2>Table of Contents</h2>
<div id="text-table-of-contents" role="doc-toc">
<ul>
<li><a href="#org5ad7370">1. Overview</a>
<ul>
<li><a href="#deps">1.1. Dependencies</a>
<ul>
<li><a href="#orgf7aa7a1">1.1.1. wave ui</a></li>
</ul>
</li>
<li><a href="#org42215a9">1.2. Getting started</a></li>
</ul>
</li>
<li><a href="#org7a9357f">2. src/</a>
<ul>
<li><a href="#orgf0e7049">2.1. main.js</a></li>
<li><a href="#appvue">2.2. App.vue</a></li>
<li><a href="#userstore">2.3. userStore.js</a></li>
<li><a href="#orgf5d503d">2.4. components/</a>
<ul>
<li><a href="#flightsuggestion">2.4.1. FlightSuggestionCard.vue</a></li>
</ul>
</li>
<li><a href="#org7e69c69">2.5. views/</a>
<ul>
<li><a href="#org4b13b7c">2.5.1. Catering.vue</a></li>
<li><a href="#org042b4f9">2.5.2. Flights.vue</a></li>
<li><a href="#homevue">2.5.3. Home.vue</a></li>
<li><a href="#orge2f1966">2.5.4. Movies.vue</a></li>
</ul>
</li>
<li><a href="#org5c1d5ca">2.6. router/</a>
<ul>
<li><a href="#routerindex">2.6.1. index.js</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-org5ad7370" class="outline-2">
<h2 id="org5ad7370"><span class="section-number-2">1.</span> Overview</h2>
<div class="outline-text-2" id="text-1">
<p>
The front-end of our flight system is built using the JavaScript framework <a href="https://vuejs.org/">Vue.js</a> and the Vue.js UI framework <a href="https://antoniandre.github.io/wave-ui/">wave ui</a>.
For more in depth information, please visit “<a href="#deps">Dependencies</a>”.
</p>
</div>
<div id="outline-container-deps" class="outline-3">
<h3 id="deps"><span class="section-number-3">1.1.</span> Dependencies</h3>
<div class="outline-text-3" id="text-deps">
<p>
The front-end dependency management is done using the <a href="https://www.npmjs.com/">npm</a> package manager. Subsequently, the necessary dependencies
are documented in <a href="../src/main/ui/package.json">package.json</a>. Developers do not have to worry about the installation of dependencies. This is handled
automatically upon building the project using one of the methods described in the <a href="../README.md">README</a>.
</p>
</div>
<div id="outline-container-orgf7aa7a1" class="outline-4">
<h4 id="orgf7aa7a1"><span class="section-number-4">1.1.1.</span> wave ui</h4>
<div class="outline-text-4" id="text-1-1-1">
<p>
wave ui custom tags can be identified by the leading <code>w</code> in the tag. An example would be:
</p>
<div class="org-src-container">
<pre class="src src-html"><<span style="color: #87cefa;">w-app</span>>
<<span style="color: #87cefa;">w-flex</span> <span style="color: #eedd82;">class</span>=<span style="color: #ffa07a;">"grow column align-center justify-center"</span>>
This is content inside a grid system.
</<span style="color: #87cefa;">w-flex</span>>
</<span style="color: #87cefa;">w-app</span>>
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org42215a9" class="outline-3">
<h3 id="org42215a9"><span class="section-number-3">1.2.</span> Getting started</h3>
<div class="outline-text-3" id="text-1-2">
<p>
We assume that you are a developer. The following instructions will start our front-end development server <a href="https://vitejs.dev/">Vite</a> and our
backend.
</p>
<p>
Open a terminal and start Vite:
</p>
<div class="org-src-container">
<pre class="src src-sh">./gradlew npm_run_dev
</pre>
</div>
<p>
Open another terminal and start the backend:
</p>
<div class="org-src-container">
<pre class="src src-sh">./gradlew bootRun
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org7a9357f" class="outline-2">
<h2 id="org7a9357f"><span class="section-number-2">2.</span> src/</h2>
<div class="outline-text-2" id="text-2">
</div>
<div id="outline-container-orgf0e7049" class="outline-3">
<h3 id="orgf0e7049"><span class="section-number-3">2.1.</span> main.js</h3>
<div class="outline-text-3" id="text-2-1">
<p>
Source the root component from <a href="#appvue">App.vue</a> to create and ultimately mount our app. Set up wave ui’s configuration.
Enables <a href="https://pinia.vuejs.org/">Pinia</a> which enables global states across the app. Currently, this is used in <a href="#userstore">src/userStore.js</a> to keep track
of whether the user has filled out the survey.
Enables the <a href="https://router.vuejs.org/">router</a> to access internal Vue URLs within our app. Mount the app.
</p>
</div>
</div>
<div id="outline-container-appvue" class="outline-3">
<h3 id="appvue"><span class="section-number-3">2.2.</span> App.vue</h3>
<div class="outline-text-3" id="text-appvue">
<div class="org-src-container">
<pre class="src src-html"><<span style="color: #87cefa;">w-app</span>></<span style="color: #87cefa;">w-app</span>>
</pre>
</div>
<p>
Custom tag of wave ui that is necessary for the proper behaviour of several wave ui elements.
</p>
<div class="org-src-container">
<pre class="src src-html"><<span style="color: #87cefa;">RouterView</span> />
</pre>
</div>
<p>
Displays the components corresponding to the current URL. As we start on <code>./</code>, <a href="#homevue">Home</a> gets displayed. Sources <a href="#routerindex">src/router/index.js</a>.
</p>
</div>
</div>
<div id="outline-container-userstore" class="outline-3">
<h3 id="userstore"><span class="section-number-3">2.3.</span> userStore.js</h3>
<div class="outline-text-3" id="text-userstore">
<p>
Global Pinia store to keep track of whether the user has logged in and filled out the survey.
</p>
</div>
</div>
<div id="outline-container-orgf5d503d" class="outline-3">
<h3 id="orgf5d503d"><span class="section-number-3">2.4.</span> components/</h3>
<div class="outline-text-3" id="text-2-4">
</div>
<div id="outline-container-flightsuggestion" class="outline-4">
<h4 id="flightsuggestion"><span class="section-number-4">2.4.1.</span> FlightSuggestionCard.vue</h4>
<div class="outline-text-4" id="text-flightsuggestion">
<p>
TODO
</p>
</div>
</div>
</div>
<div id="outline-container-org7e69c69" class="outline-3">
<h3 id="org7e69c69"><span class="section-number-3">2.5.</span> views/</h3>
<div class="outline-text-3" id="text-2-5">
</div>
<div id="outline-container-org4b13b7c" class="outline-4">
<h4 id="org4b13b7c"><span class="section-number-4">2.5.1.</span> Catering.vue</h4>
<div class="outline-text-4" id="text-2-5-1">
<div class="org-src-container">
<pre class="src src-html"><<span style="color: #87cefa;">CateringItem</span> <span style="color: #eedd82;">v-for</span>=<span style="color: #ffa07a;">"menuItem in menuItems"</span> :price=<span style="color: #ffa07a;">"menuItem.price"</span> :text=<span style="color: #ffa07a;">"menuItem.text"</span>/>
</pre>
</div>
<p>
Display multiple <code>CateringItems</code> by looping through the <code>menuItems</code> array.
</p>
</div>
</div>
<div id="outline-container-org042b4f9" class="outline-4">
<h4 id="org042b4f9"><span class="section-number-4">2.5.2.</span> Flights.vue</h4>
<div class="outline-text-4" id="text-2-5-2">
<div class="org-src-container">
<pre class="src src-js">searchDep(city) {...}
searchArr(city) {...}
</pre>
</div>
<p>
Fetch suggestions for a city code and update <code>departureSuggestions</code> and <code>arrivalSuggestions</code>
respectively.
</p>
<div class="org-src-container">
<pre class="src src-js">getFlights() {...}
</pre>
</div>
<p>
Set <code>requestedFlights</code> to <code>true</code>. Fetch suitable flights for a user-given departure-, arrival city and date
from the backend and re-render the page. This method indirectly disables the <code>Show Flights</code> button
via <code>requestedFlights</code> and shows all priorly fetched flights using the <a href="#flightsuggestion">FlightSuggestionCard</a>.
</p>
<div class="org-src-container">
<pre class="src src-js">addToJourney(flight) {...}
</pre>
</div>
<p>
Add <code>flight</code> to the end of the <code>Flights</code> table. Reset <code>requestedFlights</code> to re-enable the <code>Show Flights</code> button.
Empty the <a href="#flightsuggestion">FlightSuggestionCard</a> and re-render the page.
</p>
</div>
</div>
<div id="outline-container-homevue" class="outline-4">
<h4 id="homevue"><span class="section-number-4">2.5.3.</span> Home.vue</h4>
<div class="outline-text-4" id="text-homevue">
<div class="org-src-container">
<pre class="src src-js">data: () => ({
show*
)};
</pre>
</div>
<p>
These variables are used to toggle the visibility of UI elements such as the registration dialog depending
on if the user is logged in or not.
An example of their usage can be found later on:
</p>
<div class="org-src-container">
<pre class="src src-html"><<span style="color: #87cefa;">w-dialog</span>
<span style="color: #eedd82;">v-model</span>=<span style="color: #ffa07a;">"showRegisterDialog"</span>
:width=<span style="color: #ffa07a;">"550"</span>
<span style="color: #eedd82;">title</span>=<span style="color: #ffa07a;">"Register"</span>
>
</pre>
</div>
<div class="org-src-container">
<pre class="src src-js">mounted() {
getLoggedInUser().then(...);
</pre>
</div>
<p>
Ask the backend whether the user is currently logged in and update the <a href="#userstore">user store</a> accordingly.
</p>
<div class="org-src-container">
<pre class="src src-js"><span style="color: #00ffff;">if</span> (<span style="color: #7fffd4;">this</span>.store.username != <span style="color: #7fffd4;">null</span>) {...};
</pre>
</div>
<p>
If the user is logged in, fetch their flight from the backend, update the component’s data accordingly.
</p>
</div>
</div>
<div id="outline-container-orge2f1966" class="outline-4">
<h4 id="orge2f1966"><span class="section-number-4">2.5.4.</span> Movies.vue</h4>
<div class="outline-text-4" id="text-2-5-4">
<p>
Display a selection of previously fetched movies in a grid pattern. Depending on screen size, thumbnails
and videos get displayed at different sizes, if at all.
</p>
<div class="org-src-container">
<pre class="src src-js">beforeMount() {
<span style="color: #7fffd4;">this</span>.setMovies()
}
</pre>
</div>
<p>
Fetch a selection of movies from the backend.
</p>
</div>
</div>
</div>
<div id="outline-container-org5c1d5ca" class="outline-3">
<h3 id="org5c1d5ca"><span class="section-number-3">2.6.</span> router/</h3>
<div class="outline-text-3" id="text-2-6">
</div>
<div id="outline-container-routerindex" class="outline-4">
<h4 id="routerindex"><span class="section-number-4">2.6.1.</span> index.js</h4>
<div class="outline-text-4" id="text-routerindex">
<div class="org-src-container">
<pre class="src src-js">history: createWebHashHistory(<span style="color: #00ffff;">import</span>.meta.env.BASE_URL)
</pre>
</div>
<p>
All parts of the URL after the <code>/#/</code> are to be interpreted as internal. These get handled by the router.
All parts of the URL before the <code>/#/</code> are to be interpreted as static resources. These get handled by the web server.
</p>
<p>
The <code>routes</code> array contains mappings of all imported components to different URLs.
</p>
</div>
</div>
</div>
</div>
</div>
</body>
</html>