-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.html
619 lines (616 loc) · 38.7 KB
/
README.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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>README</title>
<style>.markdown-preview:not([data-use-github-style]) { padding: 2em; font-size: 1.2em; color: rgb(170, 187, 195); overflow: auto; background-color: rgb(38, 50, 56); }
.markdown-preview:not([data-use-github-style]) > :first-child { margin-top: 0px; }
.markdown-preview:not([data-use-github-style]) h1, .markdown-preview:not([data-use-github-style]) h2, .markdown-preview:not([data-use-github-style]) h3, .markdown-preview:not([data-use-github-style]) h4, .markdown-preview:not([data-use-github-style]) h5, .markdown-preview:not([data-use-github-style]) h6 { line-height: 1.2; margin-top: 1.5em; margin-bottom: 0.5em; color: rgb(255, 255, 255); }
.markdown-preview:not([data-use-github-style]) h1 { font-size: 2.4em; font-weight: 300; }
.markdown-preview:not([data-use-github-style]) h2 { font-size: 1.8em; font-weight: 400; }
.markdown-preview:not([data-use-github-style]) h3 { font-size: 1.5em; font-weight: 500; }
.markdown-preview:not([data-use-github-style]) h4 { font-size: 1.2em; font-weight: 600; }
.markdown-preview:not([data-use-github-style]) h5 { font-size: 1.1em; font-weight: 600; }
.markdown-preview:not([data-use-github-style]) h6 { font-size: 1em; font-weight: 600; }
.markdown-preview:not([data-use-github-style]) strong { color: rgb(255, 255, 255); }
.markdown-preview:not([data-use-github-style]) del { color: rgb(122, 149, 161); }
.markdown-preview:not([data-use-github-style]) a, .markdown-preview:not([data-use-github-style]) a code { color: rgb(77, 182, 172); }
.markdown-preview:not([data-use-github-style]) img { max-width: 100%; }
.markdown-preview:not([data-use-github-style]) > p { margin-top: 0px; margin-bottom: 1.5em; }
.markdown-preview:not([data-use-github-style]) > ul, .markdown-preview:not([data-use-github-style]) > ol { margin-bottom: 1.5em; }
.markdown-preview:not([data-use-github-style]) blockquote { margin: 1.5em 0px; font-size: inherit; color: rgb(122, 149, 161); border-color: rgb(71, 93, 105); border-width: 4px; }
.markdown-preview:not([data-use-github-style]) hr { margin: 3em 0px; border-top-width: 2px; border-top-style: dashed; border-top-color: rgb(71, 93, 105); background: none; }
.markdown-preview:not([data-use-github-style]) table { margin: 1.5em 0px; }
.markdown-preview:not([data-use-github-style]) th { color: rgb(255, 255, 255); }
.markdown-preview:not([data-use-github-style]) th, .markdown-preview:not([data-use-github-style]) td { padding: 0.66em 1em; border: 1px solid rgb(71, 93, 105); }
.markdown-preview:not([data-use-github-style]) code { color: rgb(255, 255, 255); background-color: rgb(54, 72, 80); }
.markdown-preview:not([data-use-github-style]) pre.editor-colors { margin: 1.5em 0px; padding: 1em; font-size: 0.92em; border-radius: 3px; background-color: rgb(46, 61, 68); }
.markdown-preview:not([data-use-github-style]) kbd { color: rgb(255, 255, 255); border-width: 1px 1px 2px; border-style: solid; border-color: rgb(71, 93, 105) rgb(71, 93, 105) rgb(59, 77, 86); background-color: rgb(54, 72, 80); }
.markdown-preview[data-use-github-style] { font-family: 'Helvetica Neue', Helvetica, 'Segoe UI', Arial, freesans, sans-serif; line-height: 1.6; word-wrap: break-word; padding: 30px; font-size: 16px; color: rgb(51, 51, 51); overflow: scroll; background-color: rgb(255, 255, 255); }
.markdown-preview[data-use-github-style] > :first-child { margin-top: 0px !important; }
.markdown-preview[data-use-github-style] > :last-child { margin-bottom: 0px !important; }
.markdown-preview[data-use-github-style] a:not([href]) { color: inherit; text-decoration: none; }
.markdown-preview[data-use-github-style] .absent { color: rgb(204, 0, 0); }
.markdown-preview[data-use-github-style] .anchor { position: absolute; top: 0px; left: 0px; display: block; padding-right: 6px; padding-left: 30px; margin-left: -30px; }
.markdown-preview[data-use-github-style] .anchor:focus { outline: none; }
.markdown-preview[data-use-github-style] h1, .markdown-preview[data-use-github-style] h2, .markdown-preview[data-use-github-style] h3, .markdown-preview[data-use-github-style] h4, .markdown-preview[data-use-github-style] h5, .markdown-preview[data-use-github-style] h6 { position: relative; margin-top: 1em; margin-bottom: 16px; font-weight: bold; line-height: 1.4; }
.markdown-preview[data-use-github-style] h1 .octicon-link, .markdown-preview[data-use-github-style] h2 .octicon-link, .markdown-preview[data-use-github-style] h3 .octicon-link, .markdown-preview[data-use-github-style] h4 .octicon-link, .markdown-preview[data-use-github-style] h5 .octicon-link, .markdown-preview[data-use-github-style] h6 .octicon-link { display: none; color: rgb(0, 0, 0); vertical-align: middle; }
.markdown-preview[data-use-github-style] h1:hover .anchor, .markdown-preview[data-use-github-style] h2:hover .anchor, .markdown-preview[data-use-github-style] h3:hover .anchor, .markdown-preview[data-use-github-style] h4:hover .anchor, .markdown-preview[data-use-github-style] h5:hover .anchor, .markdown-preview[data-use-github-style] h6:hover .anchor { padding-left: 8px; margin-left: -30px; text-decoration: none; }
.markdown-preview[data-use-github-style] h1:hover .anchor .octicon-link, .markdown-preview[data-use-github-style] h2:hover .anchor .octicon-link, .markdown-preview[data-use-github-style] h3:hover .anchor .octicon-link, .markdown-preview[data-use-github-style] h4:hover .anchor .octicon-link, .markdown-preview[data-use-github-style] h5:hover .anchor .octicon-link, .markdown-preview[data-use-github-style] h6:hover .anchor .octicon-link { display: inline-block; }
.markdown-preview[data-use-github-style] h1 tt, .markdown-preview[data-use-github-style] h2 tt, .markdown-preview[data-use-github-style] h3 tt, .markdown-preview[data-use-github-style] h4 tt, .markdown-preview[data-use-github-style] h5 tt, .markdown-preview[data-use-github-style] h6 tt, .markdown-preview[data-use-github-style] h1 code, .markdown-preview[data-use-github-style] h2 code, .markdown-preview[data-use-github-style] h3 code, .markdown-preview[data-use-github-style] h4 code, .markdown-preview[data-use-github-style] h5 code, .markdown-preview[data-use-github-style] h6 code { font-size: inherit; }
.markdown-preview[data-use-github-style] h1 { padding-bottom: 0.3em; font-size: 2.25em; line-height: 1.2; border-bottom-width: 1px; border-bottom-style: solid; border-bottom-color: rgb(238, 238, 238); }
.markdown-preview[data-use-github-style] h1 .anchor { line-height: 1; }
.markdown-preview[data-use-github-style] h2 { padding-bottom: 0.3em; font-size: 1.75em; line-height: 1.225; border-bottom-width: 1px; border-bottom-style: solid; border-bottom-color: rgb(238, 238, 238); }
.markdown-preview[data-use-github-style] h2 .anchor { line-height: 1; }
.markdown-preview[data-use-github-style] h3 { font-size: 1.5em; line-height: 1.43; }
.markdown-preview[data-use-github-style] h3 .anchor { line-height: 1.2; }
.markdown-preview[data-use-github-style] h4 { font-size: 1.25em; }
.markdown-preview[data-use-github-style] h4 .anchor { line-height: 1.2; }
.markdown-preview[data-use-github-style] h5 { font-size: 1em; }
.markdown-preview[data-use-github-style] h5 .anchor { line-height: 1.1; }
.markdown-preview[data-use-github-style] h6 { font-size: 1em; color: rgb(119, 119, 119); }
.markdown-preview[data-use-github-style] h6 .anchor { line-height: 1.1; }
.markdown-preview[data-use-github-style] p, .markdown-preview[data-use-github-style] blockquote, .markdown-preview[data-use-github-style] ul, .markdown-preview[data-use-github-style] ol, .markdown-preview[data-use-github-style] dl, .markdown-preview[data-use-github-style] table, .markdown-preview[data-use-github-style] pre { margin-top: 0px; margin-bottom: 16px; }
.markdown-preview[data-use-github-style] hr { height: 4px; padding: 0px; margin: 16px 0px; border: 0px none; background-color: rgb(231, 231, 231); }
.markdown-preview[data-use-github-style] ul, .markdown-preview[data-use-github-style] ol { padding-left: 2em; }
.markdown-preview[data-use-github-style] ul.no-list, .markdown-preview[data-use-github-style] ol.no-list { padding: 0px; list-style-type: none; }
.markdown-preview[data-use-github-style] ul ul, .markdown-preview[data-use-github-style] ul ol, .markdown-preview[data-use-github-style] ol ol, .markdown-preview[data-use-github-style] ol ul { margin-top: 0px; margin-bottom: 0px; }
.markdown-preview[data-use-github-style] li > p { margin-top: 16px; }
.markdown-preview[data-use-github-style] dl { padding: 0px; }
.markdown-preview[data-use-github-style] dl dt { padding: 0px; margin-top: 16px; font-size: 1em; font-style: italic; font-weight: bold; }
.markdown-preview[data-use-github-style] dl dd { padding: 0px 16px; margin-bottom: 16px; }
.markdown-preview[data-use-github-style] blockquote { padding: 0px 15px; color: rgb(119, 119, 119); border-left-width: 4px; border-left-style: solid; border-left-color: rgb(221, 221, 221); }
.markdown-preview[data-use-github-style] blockquote > :first-child { margin-top: 0px; }
.markdown-preview[data-use-github-style] blockquote > :last-child { margin-bottom: 0px; }
.markdown-preview[data-use-github-style] table { display: block; width: 100%; overflow: auto; word-break: keep-all; }
.markdown-preview[data-use-github-style] table th { font-weight: bold; }
.markdown-preview[data-use-github-style] table th, .markdown-preview[data-use-github-style] table td { padding: 6px 13px; border: 1px solid rgb(221, 221, 221); }
.markdown-preview[data-use-github-style] table tr { border-top-width: 1px; border-top-style: solid; border-top-color: rgb(204, 204, 204); background-color: rgb(255, 255, 255); }
.markdown-preview[data-use-github-style] table tr:nth-child(2n) { background-color: rgb(248, 248, 248); }
.markdown-preview[data-use-github-style] img { max-width: 100%; box-sizing: border-box; }
.markdown-preview[data-use-github-style] .emoji { max-width: none; }
.markdown-preview[data-use-github-style] span.frame { display: block; overflow: hidden; }
.markdown-preview[data-use-github-style] span.frame > span { display: block; float: left; width: auto; padding: 7px; margin: 13px 0px 0px; overflow: hidden; border: 1px solid rgb(221, 221, 221); }
.markdown-preview[data-use-github-style] span.frame span img { display: block; float: left; }
.markdown-preview[data-use-github-style] span.frame span span { display: block; padding: 5px 0px 0px; clear: both; color: rgb(51, 51, 51); }
.markdown-preview[data-use-github-style] span.align-center { display: block; overflow: hidden; clear: both; }
.markdown-preview[data-use-github-style] span.align-center > span { display: block; margin: 13px auto 0px; overflow: hidden; text-align: center; }
.markdown-preview[data-use-github-style] span.align-center span img { margin: 0px auto; text-align: center; }
.markdown-preview[data-use-github-style] span.align-right { display: block; overflow: hidden; clear: both; }
.markdown-preview[data-use-github-style] span.align-right > span { display: block; margin: 13px 0px 0px; overflow: hidden; text-align: right; }
.markdown-preview[data-use-github-style] span.align-right span img { margin: 0px; text-align: right; }
.markdown-preview[data-use-github-style] span.float-left { display: block; float: left; margin-right: 13px; overflow: hidden; }
.markdown-preview[data-use-github-style] span.float-left span { margin: 13px 0px 0px; }
.markdown-preview[data-use-github-style] span.float-right { display: block; float: right; margin-left: 13px; overflow: hidden; }
.markdown-preview[data-use-github-style] span.float-right > span { display: block; margin: 13px auto 0px; overflow: hidden; text-align: right; }
.markdown-preview[data-use-github-style] code, .markdown-preview[data-use-github-style] tt { padding: 0.2em 0px; margin: 0px; font-size: 85%; border-radius: 3px; background-color: rgba(0, 0, 0, 0.0392157); }
.markdown-preview[data-use-github-style] code::before, .markdown-preview[data-use-github-style] tt::before, .markdown-preview[data-use-github-style] code::after, .markdown-preview[data-use-github-style] tt::after { letter-spacing: -0.2em; content: " "; }
.markdown-preview[data-use-github-style] code br, .markdown-preview[data-use-github-style] tt br { display: none; }
.markdown-preview[data-use-github-style] del code { text-decoration: inherit; }
.markdown-preview[data-use-github-style] pre > code { padding: 0px; margin: 0px; font-size: 100%; word-break: normal; white-space: pre; border: 0px; background: transparent; }
.markdown-preview[data-use-github-style] .highlight { margin-bottom: 16px; }
.markdown-preview[data-use-github-style] .highlight pre, .markdown-preview[data-use-github-style] pre { padding: 16px; overflow: auto; font-size: 85%; line-height: 1.45; border-radius: 3px; background-color: rgb(247, 247, 247); }
.markdown-preview[data-use-github-style] .highlight pre { margin-bottom: 0px; word-break: normal; }
.markdown-preview[data-use-github-style] pre { word-wrap: normal; }
.markdown-preview[data-use-github-style] pre code, .markdown-preview[data-use-github-style] pre tt { display: inline; max-width: initial; padding: 0px; margin: 0px; overflow: initial; line-height: inherit; word-wrap: normal; border: 0px; background-color: transparent; }
.markdown-preview[data-use-github-style] pre code::before, .markdown-preview[data-use-github-style] pre tt::before, .markdown-preview[data-use-github-style] pre code::after, .markdown-preview[data-use-github-style] pre tt::after { content: normal; }
.markdown-preview[data-use-github-style] kbd { display: inline-block; padding: 3px 5px; font-size: 11px; line-height: 10px; color: rgb(85, 85, 85); vertical-align: middle; border-style: solid; border-width: 1px; border-color: rgb(204, 204, 204) rgb(204, 204, 204) rgb(187, 187, 187); border-radius: 3px; box-shadow: rgb(187, 187, 187) 0px -1px 0px inset; background-color: rgb(252, 252, 252); }
.markdown-preview[data-use-github-style] a { color: rgb(51, 122, 183); }
.markdown-preview[data-use-github-style] code { color: inherit; }
.markdown-preview[data-use-github-style] pre.editor-colors { padding: 0.8em 1em; margin-bottom: 1em; font-size: 0.85em; border-radius: 4px; overflow: auto; }
.scrollbars-visible-always .markdown-preview pre.editor-colors::shadow .vertical-scrollbar, .scrollbars-visible-always .markdown-preview pre.editor-colors::shadow .horizontal-scrollbar { visibility: hidden; }
.scrollbars-visible-always .markdown-preview pre.editor-colors:hover::shadow .vertical-scrollbar, .scrollbars-visible-always .markdown-preview pre.editor-colors:hover::shadow .horizontal-scrollbar { visibility: visible; }
.markdown-preview { color: rgba(170, 187, 195, 0.8); background-color: rgb(42, 55, 62); }
.markdown-preview code { color: rgba(170, 187, 195, 0.8); background-color: rgb(46, 61, 68); }
.markdown-preview h1, .markdown-preview h2, .markdown-preview h3 { border-color: rgba(170, 187, 195, 0.0980392); }
.markdown-preview table tr { border-color: rgb(59, 77, 86); background: none; }
.markdown-preview table tr:nth-child(2n) { background-color: rgb(46, 61, 68); }
.markdown-preview table th, .markdown-preview table td { border-color: rgb(59, 77, 86); }
.markdown-preview table th { background-color: rgb(54, 72, 80); }
html.blue .markdown-preview a { color: rgb(33, 150, 243); }
html.cyan .markdown-preview a { color: rgb(0, 188, 212); }
html.green .markdown-preview a { color: rgb(139, 195, 74); }
html.pink .markdown-preview a { color: rgb(233, 30, 99); }
html.purple .markdown-preview a { color: rgb(130, 89, 203); }
html.red .markdown-preview a { color: rgb(244, 67, 54); }
html.teal .markdown-preview a { color: rgb(77, 182, 172); }
html.white .markdown-preview a { color: rgb(196, 196, 196); }
html.yellow .markdown-preview a { color: rgb(255, 235, 59); }
html.orange .markdown-preview a { color: rgb(255, 152, 0); }
.gutter .line-number {
background-size: 0px;
transition: background-size 0.5s;
}
.gutter .line-number.quickfix {
background-image: url(atom://atom-typescript/images/light-bulb.png);
background-size: 16.66666667px;
background-repeat: no-repeat;
background-position: right center;
}
.bracket-matcher .region {
border-bottom: 1px dotted lime;
position: absolute;
}
.spell-check-misspelling .region {
border-bottom: 2px dotted rgba(255, 51, 51, 0.75);
}
pre.editor-colors,
.host {
background-color: #263238;
color: #aabbc3;
}
pre.editor-colors .gutter,
.host .gutter {
background-color: #263238;
color: #49656f;
}
pre.editor-colors .gutter .line-number.cursor-line,
.host .gutter .line-number.cursor-line {
background-color: rgba(0, 0, 0, 0.19);
color: #cdd3de;
}
pre.editor-colors .gutter .line-number.cursor-line-no-selection,
.host .gutter .line-number.cursor-line-no-selection {
color: #cdd3de;
}
pre.editor-colors .wrap-guide,
.host .wrap-guide {
color: #2b3940;
}
pre.editor-colors .indent-guide,
.host .indent-guide {
color: #2b3940;
}
pre.editor-colors .invisible-character,
.host .invisible-character {
color: #304047;
}
pre.editor-colors .search-results .marker .region,
.host .search-results .marker .region {
background-color: transparent;
border: #65737e;
}
pre.editor-colors .search-results .marker.current-result .region,
.host .search-results .marker.current-result .region {
border: #cdd3de;
}
pre.editor-colors.is-focused .cursor,
.host(.is-focused) .cursor {
border-color: #4db6ac;
border-width: 2px;
}
pre.editor-colors.is-focused .selection .region,
.host(.is-focused) .selection .region {
background-color: rgba(128, 203, 196, 0.13);
}
pre.editor-colors.is-focused .line-number.cursor-line-no-selection,
pre.editor-colors.is-focused .line.cursor-line,
.host(.is-focused) .line-number.cursor-line-no-selection,
.host(.is-focused) .line.cursor-line {
background-color: rgba(0, 0, 0, 0.19);
}
.variable.parameter.function {
color: #eeffff;
}
.comment,
.punctuation.definition.comment {
color: #49656f;
}
.punctuation.definition.string,
.punctuation.definition.variable,
.punctuation.definition.string,
.punctuation.definition.parameters,
.punctuation.definition.string,
.punctuation.definition.array {
color: #d9f5dd;
}
.none {
color: #d9f5dd;
}
.keyword.operator {
color: #d9f5dd;
}
.keyword {
color: #ae94dd;
}
.variable {
color: #ed5866;
}
.variable .punctuation.definition.variable {
color: inherit;
}
.entity.name.function,
.meta.require,
.support.function.any-method,
.meta.function-call,
.support.function,
.keyword.other.special-method,
.meta.block-level {
color: #82b1ff;
}
.support.class,
.entity.name.class,
.entity.name.type.class {
color: #f4cf5f;
}
.meta.class {
color: #fff;
}
.keyword.other.special-method {
color: #82b1ff;
}
.storage {
color: #ae94dd;
}
.support.function,
.keyword.operator,
.constant.other.color,
.meta.tag,
.punctuation.definition.tag,
.punctuation.separator.inheritance.php,
.punctuation.definition.tag.html,
.punctuation.definition.tag.begin.html,
.punctuation.definition.tag.end.html {
color: #80cbc4;
}
.string,
.constant.other.symbol,
.entity.other.inherited-class {
color: #c3e88d;
}
.constant.numeric {
color: #ee6f65;
}
.none {
color: #ee6f65;
}
.none {
color: #ee6f65;
}
.constant {
color: #ee6f65;
}
.entity.name.tag {
color: #ed5866;
}
.entity.other.attribute-name {
color: #c3e88d;
}
.entity.other.attribute-name.class.css {
color: #FFC55C;
}
.entity.other.attribute-name.class.css .punctuation.entity {
color: #FFC55C;
}
.entity.other.attribute-name.id {
color: #fad430;
}
.entity.other.attribute-name.id .punctuation.entity {
color: #fad430;
}
.entity.other.attribute-name .punctuation.entity {
color: #ae94dd;
}
.meta.selector {
color: #ae94dd;
}
.none {
color: #ee6f65;
}
.markup.heading .punctuation.definition.heading,
.entity.name.section {
color: #75cbf2;
}
.keyword.other.unit {
color: #ee6f65;
}
.markup.bold,
.punctuation.definition.bold {
font-weight: bold;
color: #f4cf5f;
}
.markup.italic,
.punctuation.definition.italic {
font-style: italic;
color: #ae94dd;
}
.markup.raw.inline,
.markup.raw {
color: #f1e655;
}
.string.other.link,
.punctuation.definition.string.end.markdown {
color: #ff5370;
}
[data-grammar*="gfm"]::shadow .markup.underline.link {
color: #ff869a;
}
[data-grammar*="gfm"]::shadow .markup.underline.link span.punctuation {
color: #ff5370;
}
[data-grammar*="gfm"]::shadow .markup.strike {
position: relative;
color: rgba(170, 187, 195, 0.5);
}
[data-grammar*="gfm"]::shadow .markup.strike::after {
content: "";
position: absolute;
top: calc(54%);
left: 0;
right: 0;
height: 1px;
background-color: rgba(170, 187, 195, 0.2);
}
[data-grammar*="gfm"]::shadow .table .border {
color: rgba(170, 187, 195, 0.5);
}
[data-grammar*="gfm"]::shadow .markup.heading {
color: #82b1ff;
}
[data-grammar*="gfm"]::shadow .punctuation.definition.begin,
[data-grammar*="gfm"]::shadow .punctuation.definition.end {
color: #82b1ff;
}
[data-grammar*="gfm"]::shadow .punctuation.definition.begin + span:not(.function.parameter) {
color: #9cc1ff;
}
.meta.link {
color: #ee6f65;
}
.markup.list {
color: #ed5866;
}
.markup.quote {
color: #ee6f65;
}
.meta.separator {
color: #d9f5dd;
background-color: #1e3445;
}
.markup.inserted {
color: #f1e655;
}
.markup.deleted {
color: #ed5866;
}
.markup.changed {
color: #ae94dd;
}
.constant.other.color,
.meta.property-value .support.constant.named-color.css {
color: #ffeb95;
}
.string.regexp {
color: #80cbc4;
}
.constant.character.escape {
color: #80cbc4;
}
.punctuation.section.embedded,
.variable.interpolation {
color: #d3423e;
}
.invalid.illegal {
color: #ffffff;
background-color: #ec5f67;
}
.invalid.broken {
color: #020e14;
background-color: #ee6f65;
}
.invalid.deprecated {
color: #ffffff;
background-color: #d3423e;
}
.invalid.unimplemented {
color: #ffffff;
background-color: #8bd649;
}
.sublimelinter.annotations {
color: #7b5157;
background-color: #fffff7;
}
.sublimelinter.outline.illegal {
color: #ffffff;
background-color: #ff9599;
}
.sublimelinter.underline.illegal {
background-color: #ff4941;
}
.sublimelinter.outline.warning {
color: #ffffff;
background-color: #ffcf1b;
}
.sublimelinter.underline.warning {
background-color: #ff4941;
}
.sublimelinter.outline.violation {
color: #ffffff;
background-color: rgba(255, 255, 255, 0.2);
}
.sublimelinter.underline.violation {
background-color: #ff4941;
}
.sublimelinter.mark.error {
color: #ff572d;
}
.sublimelinter.mark.warning {
color: #ffcf1b;
}
.sublimelinter.gutter-mark {
color: #ffffff;
}
.markup.deleted.git_gutter {
color: #ec5f67;
}
.markup.changed.git_gutter {
color: #ffcf1b;
}
.markup.inserted.git_gutter {
color: #c3e88d;
}
.markup.ignored.git_gutter {
color: #546e7a;
}
.comment.line.double-slash .punctuation.definition.comment,
.meta.structure.array .comment.block.json .punctuation.definition.comment {
color: #49656f;
}
.support.type.property-name {
color: #80cbc4;
}
.meta.property-list .meta.property-name {
color: #80cbc4;
}
.source.css .keyword.other.unit,
.source.less .keyword.other.unit,
.source.scss .keyword.other.unit,
.source.sass .keyword.other.unit {
color: #ffeb95;
}
.entity.other.less.mixin {
color: #7986cb;
}
.constant.other.color.rgb-value .punctuation.definition.constant {
color: #ee6f65;
}
.meta.attribute-selector .string.unquoted.attribute-value {
color: #c3e88d;
}
.meta.attribute-selector .entity.other.attribute-name.attribute {
color: #ee6f65;
}
.bracket-matcher .region {
border-bottom: 1px solid #4db6ac;
box-sizing: border-box;
background-color: #364850;
box-shadow: inset 0 -1px 0 #4db6ac;
}
</style>
</head>
<body class='markdown-preview'><h1 id="league-mgr">League-Mgr</h1>
<p>Server based on nodejs, koa(web framework), mongoose(ORM for mongo) supporting</p>
<ul>
<li>REST : client/server communication</li>
<li>JWT : JsonWebToken for admin authentication</li>
</ul>
<h2 id="live-example-on-localhost-9995-">Live Example on <em>localhost:9995</em></h2>
<h2 id="specs">Specs</h2>
<ul>
<li>Public APIs: Expose Public APIs to get the following info</li>
<li>List of upcoming games
curl -i "<a href="http://localhost:9995/v1/league/5697d05d920eb16b4f2bc4f3/games?gametime=n">http://localhost:9995/v1/league/5697d05d920eb16b4f2bc4f3/games?gametime=n</a>"</li>
<li>List of past games
curl -i "<a href="http://localhost:9995/v1/league/5697d05d920eb16b4f2bc4f3/games?gametime=p">http://localhost:9995/v1/league/5697d05d920eb16b4f2bc4f3/games?gametime=p</a>"</li>
<li>List of Teams
curl -i "<a href="http://localhost:9995/v1/league/5697d05d920eb16b4f2bc4f3/teams">http://localhost:9995/v1/league/5697d05d920eb16b4f2bc4f3/teams</a>"</li>
<li>Team Info
curl -i "<a href="http://localhost:9995/v1/team/5697d05e920eb16b4f2bc503">http://localhost:9995/v1/team/5697d05e920eb16b4f2bc503</a>"</li>
</ul>
<p>added</p>
<ul>
<li><p>list of leagues : /v1/league?season=<year></year></p>
<ul>
<li>by default, current season is assumed
curl -i "<a href="http://localhost:9995/v1/league?season=2015">http://localhost:9995/v1/league?season=2015</a>"</li>
</ul>
</li>
<li><p>Admin APIs: Expose Admin APIs to get the following info</p>
</li>
</ul>
<p>Please refer to the 'Testing' section for admin operations</p>
<ul>
<li><p>Create/Update/Delete Tournament : /v1/league CRUD</p>
<ul>
<li>cascade delete games, teams if league is deleted</li>
</ul>
</li>
<li><p>Create/Update/Delete Games : /v1/league/<league-id>/game, /v1/game/<game-id> CRUD</game-id></league-id></p>
<ul>
<li>check for league id validity during creation/updation</li>
<li>check for team league equality with game league validity during creation/updation</li>
<li>delete teamname updation through game updation</li>
</ul>
</li>
<li><p>Create/Update/Delete Teams : /v1/league/<league-id>/team, /v1/team/<team-id> CRUD</team-id></league-id></p>
<ul>
<li>check for league id validity during creation/updation</li>
<li>update team name in game docs during team updation</li>
<li>delete games if team is deleted</li>
</ul>
</li>
<li><p>populate league info</p>
</li>
<li>Build a simple Server Side Batch Job to Read and populate Barclays Premier League or any other league tournament info feel free to use any available public data, or perform web scraping<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span># using data from </span><span class="markup underline link http hyperlink"><span>http://www.football-data.co.uk/englandm.php</span></span></span></span></div><div class="line"><span class="text plain"><span class="meta paragraph text"><span># football-data.org : X-Auth-Token: 75e849c09ea84724a4f30043b52e08e2</span></span></span></div><div class="line"><span class="text plain"><span class="meta paragraph text"><span>./script/insertLeague.js -y 2015</span></span></span></div></pre></li>
</ul>
<p>TODO : automated testing</p>
<h2 id="running">Running</h2>
<h3 id="server">server</h3>
<pre class="editor-colors lang-bash"><div class="line"><span class="source shell"><span class="comment line number-sign shell"><span class="punctuation definition comment shell"><span>#</span></span><span> edit server/config/config.js</span><span> </span></span></span></div><div class="line"><span class="source shell"><span>node app.js</span></span></div></pre>
<h2 id="testing">Testing</h2>
<p>For PUT, DELETE, POST operations, admin user signin header need to be supplied. as follows:</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span>-H 'authorization: bearer <auth-jwt>'</span></span></span></div></pre><p>For the same, an admin user needs to be created, as follows:</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span>curl -i </span><span class="markup underline link http hyperlink"><span>http://localhost:9995/v1/signup?pin=92111</span></span><span> -X POST -H 'content-type:application/json' -d '{ "name" : "admin", "password" : "fl@123", "phone" : "9711993235", "roles" : ["admin"] }'</span></span></span></div></pre><p>Once created, authorization response header can be received by signing into the server, as follows:</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span>curl -i </span><span class="markup underline link http hyperlink"><span>http://localhost:9995/v1/signin</span></span><span> -X POST -H 'content-type:application/json' -d '{ "userId" : "9711993235", "password" : "fl@123" }'</span></span></span></div></pre><h3 id="league">League</h3>
<ul>
<li><p>get</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span>curl -i </span><span class="markup underline link http hyperlink"><span>http://localhost:9995/v1/league?season=2016</span></span></span></span></div></pre></li>
<li><p>create</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span>curl -i </span><span class="markup underline link http hyperlink"><span>http://localhost:9995/v1/league</span></span><span> -X POST -H 'content-type:application/json' -d '{ "name" : "Barclays Premier League 2016", "league" : "BPL", "season" : 2016}'</span></span></span></div></pre></li>
<li><p>update</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span>curl -i </span><span class="markup underline link http hyperlink"><span>http://localhost:9995/v1/league/</span></span><span><league-id> -X PUT -H 'content-type:application/json' -d '{ "name" : "Barclays Premier League 2016" }'</span></span></span></div></pre></li>
<li><p>delete</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span>curl -i </span><span class="markup underline link http hyperlink"><span>http://localhost:9995/v1/league/</span></span><span><league-id> -X DELETE</span></span></span></div></pre></li>
</ul>
<h3 id="team">Team</h3>
<ul>
<li><p>get</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span>curl -i </span><span class="markup underline link http hyperlink"><span>http://localhost:9995/v1/league/</span></span><span><league-id>/teams</span></span></span></div></pre></li>
<li><p>create</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span>curl -i </span><span class="markup underline link http hyperlink"><span>http://localhost:9995/v1/league/56974bb4cf59f89b231aebc7/team</span></span><span> -X POST -H 'content-type:application/json' -d '{ "name" : "Manchester United", "nickName" : "ManU", "site" : "</span><span class="markup underline link http hyperlink"><span>http://www.manu.com</span></span><span>" }'</span></span></span></div></pre></li>
<li><p>update</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span>curl -i </span><span class="markup underline link http hyperlink"><span>http://localhost:9995/v1/team/</span></span><span><team-id> -X PUT -H 'content-type:application/json' -d '{ "nickName" : "MANU" }'</span></span></span></div></pre></li>
<li><p>delete</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span class="meta paragraph text"><span>curl -i </span><span class="markup underline link http hyperlink"><span>http://localhost:9995/v1/team/56969dfd5224d439173c5f7a</span></span><span> -X DELETE</span></span></span></div></pre></li>
</ul>
<h3 id="game">Game</h3>
<ul>
<li>get
```
curl -i <a href="http://localhost:9995/v1/league/">http://localhost:9995/v1/league/</a><league-id>/games
curl -i <a href="http://localhost:9995/v1/league/">http://localhost:9995/v1/league/</a><league-id>/games?gametime=p|n&gamedate=<date>
gametime
p => past
n => upcoming</date></league-id></league-id></li>
</ul>
<p>gamedate
greater/less than the date (depending on <gametime>)
games are order by date descending</gametime></p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span> </span></span></div><div class="line"><span class="text plain"><span class="meta bullet-point star text"><span class="punctuation definition item text"><span>*</span></span><span> create</span></span></span></div></pre><p>curl -i <a href="http://localhost:9995/v1/league/56974bb4cf59f89b231aebc7/game">http://localhost:9995/v1/league/56974bb4cf59f89b231aebc7/game</a> -X POST -H 'content-type:application/json' -d '{ "date" : "2016/01/16 20:00:00", "homeTeamId" : "569753bda6b8385c27bc45ed", "awayTeamId" : "569756afd378653f286d5fde" }'</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span> </span></span></div><div class="line"><span class="text plain"><span class="meta bullet-point star text"><span class="punctuation definition item text"><span>*</span></span><span> update</span></span></span></div></pre><p>curl -i <a href="http://localhost:9995/v1/game/">http://localhost:9995/v1/game/</a><game-id> -X PUT -H 'content-type:application/json' -d '{ "date" : "2016/02/17" }'</game-id></p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span> </span></span></div><div class="line"><span class="text plain"><span class="meta bullet-point star text"><span class="punctuation definition item text"><span>*</span></span><span> delete</span></span></span></div></pre><p>curl -i <a href="http://localhost:9995/v1/game/">http://localhost:9995/v1/game/</a><game-id> -X DELETE</game-id></p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span> </span></span></div><div class="line"><span class="text plain"><span class="meta paragraph text"><span>### User</span></span></span></div><div class="line"><span class="text plain"><span class="meta paragraph text"><span>* Add a user</span></span></span></div></pre><p>curl -i <a href="http://localhost:9995/v1/signup?pin=92111">http://localhost:9995/v1/signup?pin=92111</a> -X POST -H 'content-type:application/json' -d '{ "name" : "admin", "password" : "fl@123", "phone" : "9711993235", "roles" : ["admin"] }'</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span> </span></span></div><div class="line"><span class="text plain"><span class="meta bullet-point star text"><span class="punctuation definition item text"><span>*</span></span><span> sign in using the created user</span></span></span></div></pre><p>curl -i <a href="http://localhost:9995/v1/signin">http://localhost:9995/v1/signin</a> -d '{ "userId" : "9711993235", "password" : "fl@123" }' -X POST -H 'Content-Type:application/json'</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span> </span></span></div><div class="line"><span class="text plain"><span class="meta bullet-point star text"><span class="punctuation definition item text"><span>*</span></span><span> signout</span></span></span></div></pre><p>curl -i <a href="http://localhost:9995/v1/signout">http://localhost:9995/v1/signout</a> (secured)</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span> </span></span></div><div class="line"><span class="text plain"><span class="meta bullet-point star text"><span class="punctuation definition item text"><span>*</span></span><span> Update a user. In url provide Object id of user as returned in response by server while user creation.</span></span></span></div></pre><p>curl -i <a href="http://localhost:9995/v1/user?pin=92111">http://localhost:9995/v1/user?pin=92111</a> -d '{ "password" : "ah@123" }' -X PUT -H 'content-type: application/json'</p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span> </span></span></div><div class="line"><span class="text plain"><span class="meta bullet-point star text"><span class="punctuation definition item text"><span>*</span></span><span> Delete a user. In url provide object id of user as returned in response by server while user creation.</span></span></span></div></pre><p>curl -i <a href="http://localhost:9995/v1/user">http://localhost:9995/v1/user</a> -X DELETE
curl -i <a href="http://localhost:9995/v1/user/">http://localhost:9995/v1/user/</a><userid> -X DELETE</userid></p>
<pre class="editor-colors lang-text"><div class="line"><span class="text plain"><span> </span></span></div><div class="line"><span class="text plain"><span class="meta paragraph text"><span>## Debug the server</span></span></span></div><div class="line"><span class="text plain"><span class="meta paragraph text"><span>launch it as follows:</span></span></span></div><div class="line"><span class="text plain"><span class="meta paragraph text"><span>```bash</span></span></span></div><div class="line"><span class="text plain"><span class="meta paragraph text"><span>node-debug app.js</span></span></span></div></pre><h2 id="batch-job-to-populate-league-data">batch job to populate league data</h2>
<p><em>populate barclays data</em></p>
<pre class="editor-colors lang-bash"><div class="line"><span class="source shell"><span>node scripts/insertBPL.js</span></span></div></pre>
<h2 id="code-layout">Code layout</h2>
<h3 id="config">config</h3>
<p>./server/config/config.js</p>
<h3 id="middleware-config">middleware config</h3>
<p>./server/config/koa.js</p>
<h3 id="data-models">Data models</h3>
<p>refer ./fl-common/models</p>
<h3 id="controllers">controllers</h3>
<p>refer ./server/controllers</p>
<h2 id="credits">Credits</h2>
<p>Server side simply utilizes generally accepted Koa middleware and Node.js best practices.</p>
<h2 id="the-name">The Name</h2>
<p>The project name is League Mgr</p>
<h2 id="license">License</h2>
<p>Copyright, Amit Handa</p></body>
</html>