-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathtutorial.html
459 lines (340 loc) · 26.8 KB
/
tutorial.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
---
title: Learn Puppy
description: Learn Puppy in 15 minutes or less
menu: false
---
{% extends "@templates/layouts/base.twig" %}
{% block meta %}
<link rel="icon" href="/static/img/favicon.png" />
{% endblock %}
{% block styles %}
<link rel="stylesheet" type="text/css" href="{{ puppy.assetUrl('tutorial.css') }}">
{% endblock %}
{% block content %}
<div class="tutorial">
<nav class="sidebar">
<div class="sidebar__inner">
<header>
Table of Contents
</header>
<ul class="sidebar__items">
{# Populated with JS #}
</ul>
</div>
</nav>
<main class="content">
<section id="intro">
<h1 class="heading">🐶 Puppy Tutorial 🐶</h1>
<br>
<p>Welcome to Puppy! We're glad you're here. If you're reading this, you've already installed a Puppy project and have run <code>npm start</code>. We commend you!</p>
<p>If you still need to do that or are having issues, check out the <a href="https://github.com/Upstatement/puppy#-install">Puppy README</a> for more info.</p>
<p>The goal of this tutorial is to guide you through setting up and deploying your first Puppy project. Some basic web development knowledge is required, but if you're a beginner, these concepts shouldn't be too hard to grasp. If this isn't your first Puppy party, it's safe to delete this page and do your thing.</p>
<p>Otherwise, allow us to show you around!</p>
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAADgCAYAAADsQbhQAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAB4ISURBVHhe7ZxBjuvYlURr0gMD3oB30EBvwKNehVfkTXjsjXghPfcOPP8tZmUwDyPjPlKiKDGL9wEHyRcnrqwSdFVuoOHfbudX0zSXJYZN01yDGDZNcw1i2DTNNYhh0zTXIIZN01yDGDZNcw1i2DTNNYhh0zTXIIZN01yDGDZNcw1i2DTNNYhh0zTXIIZN01yDGDZNcw1i2DTNNYjhZv72t79dmvSZVPz6559//fr3/30x3T/Povd5UjYd5nupTurugSf5d/Kvv/zpg+SEOt71nGzxJyCGm0lLcSXSZ5KYF/6Tjww/ANP5yHDmWXueju570VnL9qDjz2dh60Km3trsmj8BMdxMWoorkT4Tx5efPwAff8OZZz+P7lX2KDpr2aPorGXvZOuSpt7a7Jo/ATHcTFqKK5E+E+KLL+TmHo4y5mvZVv7nv38tqE7V52slvK/Djk7qs/cMtIBO6jBLjGadZ/kXEMPNpKW4EukzIdW//RedcNylPrMt+LJN6LCnU82wS1J3dKoZf92j2bp0qbc2u+ZPQAw3k5biSqTPhJT/t7+ecdKdGe96voe0YDpr2cTagh79+kexdUlTb212zZ+AGG4mLcWVSJ8JmX4AFncs/8f98yw6nydl02F+D6MF9cOOWFvQ0euvZRNrr38UWlJn1PGcXcIZJ/XfQAw3k5biSqTPhGjh53/jY/lfzd4FW5s/+vWbQ4jhZtJSXIn0mZyVoxf06NdvDiGGm0lLcSXSZ3JWjl7Qo1+/OYQYbiYtxZVIn8lZOXpBj3795hBiuJm0FFcifSZn5egFPfr1m0OI4WbSUlyJ9JmclaMX9OjXbw4hhptJS3El0mdyVo5e0KNfvzmEGG4mLcWVSJ/JWTl6QY9+/eYQYriZtBRXIn0mZ+XoBT369ZtDiOFm0lJcifSZjPj2/xj0eRadz5Oy6TC/h6MX9OjXbw4hhptJS3El0mdSwf8vwPmHAOcjx5m79jwd3e/h6AU9+vWbQ4jhZtJSXIn0mVTwB4D3dObO59G9yrZw9IIe/frNIcRwM2kprkT6TEb4fwuYn3GUMV/LtnD0gh79+s0hxHAzaSmuRPpMKuZ/49/+Vsuv4073KtvC0Qt69Os3hxDDzaSluBLpM0lw4Rc5Troz413P93D0gh79+s0hxHAzaSmuRPpMHP6b/5v7PFuz6TC/h6MX9OjXbw4hhptJS3El0mdCRsv/ao5e0KNfvzmEGG4mLcWVSJ/JVnhSnrLpML+Hoxf06Nev4P/CTvpf29nr/+DEcDNpKa5E+kwSU1dfcH3J/XimWX+eju738OiCibX5o18/oYVNPMNfgBhuxhfiaqTPxJl605n+6kvOL3o67nSvsi08smBkbf7o10+kxRXP8BcghpvhMlyR9JmQqTOd6a++4EQ9Hs7rrGVbSP/5j5BeeyJ1HyG9dkVaXPEMfwFiuBkuw6v4+39+m0n+laTPhEyd6Ux/qy97OprX0b3KtpLewz2k1yRp5h7Sa45Iiyue4S9ADDfDZXgVP+kHYPpSTz3/ogueqc+j19DhXc9NXuJn+j84MdyML8Qr+Ek/ABNp8Scmp8O+Tsqmw7z5nbXl3ev/wMRwM2kprkT6TBJp+Zvnsra8e/0flBg2TXMNYtg0zTWIYdM01yCGTdNcgxg2TXMNYtg0zTWIYdM01yCGTdNcgf/9r99+iVSoHOeqDntVTrzDXpUT77BX5cQ77FU58Q57VU68w16VE++wV+XEO+xVOfEOe1VOvMNelRPvsFflxDvsVTnxDntVTrzDXpUT77BX5nqYg1CqfOqMnPvUGTn3qTNy7lNn5Nynzsi5T52Rc586I+c+dUbOfeqMnPvUGTn3qTNy7lNn5Nynzsi5T52Rc586I+f+g1HBHb2eK58cvZ4rnxy9niufHL2eK58cvZ4rnxy9niufHL2eK58cvZ4rnxy9niufHL2eK58cvZ4rnxy9niufHL2eK58cvZ4rnxy9niufHD2ec8FzIpd6yjwncqmnzHMil3rKPCdyqafMcyKXeso8J3Kpp8xzIpd6yjwncqmnzHMil3rKPCdyqafMcyKXeso8J3Kpp8xzIpd6yjwncqmnzHMil3rKPCdyn73v0jNHPnV7vud7fpk5p5pPcu0FROr1fM/3/Pc8cYb5u34A5EjV8ZyOVB3P6UjV8ZyOVB3P6UjV8ZyOVB3P6UjV8ZyOVB3P6UjV8ZyOVB3P6UjV8ZyOVB3P6UjV8ZyOVB3P6UjV8ZxuQVVKud+rXs/n3O89v8zW8q29Kvd7z9+YLmIObzCXW8t6vud7/mfN9w+A3Xu+5680f2NxWWDF+e59vzOn0937fmdOp7v3/c6cTnfv+505ne7e9ztzOt2973fmdLp73+/M6XT3vt+Z0+nufb8zp9Pd+35nTqe79/3OnE537/udOZ3u3vc7czrdve935nS6e9/vzOl0t/63YMGGF+j5nl/cSc8vn083XxXEXDTPLHkh555Z8kLOPbPkhZx7ZskLOffMkhdy7pklL+TcM0teyLlnlryQc88seSHnnlnyQs49s+SFnHtmyQs598ySF3LumSUv5NwzS17IuZ9zXlhYlIJnljzz5Jklzzx5ZskzT55Z8syTZ5Y88+SZJc88eWbJM0+eWfLMk2eWPPPkmSXPPHlmyTNPnlnyzJNnljzz5Jklzzx5ZskzT37OdaEkcxEdz+gc76aMzvFuyugc76aMzvFuyugc76aMzvFuyugc76aMzvFuyugc76aMzvFuyugc76aMzvFuyugc76aMzvFuyugc73p240vqbyit0vNff3v+u1+j57/+vnReA9VQ5ThXddircuId9qqceIe9KifeYa/KiXfYq3LiHfaqnHiHvSon3mGvyol32Kty4h32qpx4h70qJ95hr8qJd9ircuId9qqceIe9MtfDHIRS5VNn5Nynzsi5T52Rc586I+c+dUbOfeqMnPvUGTn3qTNy7lNn5Nynzsi5T52Rc586I+c+dUbOfeqMnPvUGTn3H4wK7uj1XPnk6PVc+eTo9Vz55Oj1XPnk6PVc+eTo9Vz55Oj1XPnk6PVc+eTo9Vz55Oj1XPnk6PVc+eTo9Vz55Oj1XPnk6PVc+eTo9Vz55OjxnAueE7nUU+Y5kUs9ZZ4TudRT5jmRSz1lnhO51FPmOZFLPWWeE7nUU+Y5kUs9ZZ4TudRT5jmRSz1lnhO51FPmOZFLPWWeE7nUU+Y5kUs9ZZ4TudRT5jmR++x9l5458qnb8z3f88vMOdV8kmsvIFKv53u+57/niTPM3/UDIEeqjud0pOp4Tkeqjud0pOp4Tkeqjud0pOp4Tkeqjud0pOp4Tkeqjud0pOp4Tkeqjud0pOp4Tkeqjud0pOp4Tkeqjud0C6pSyv1e9Xo+537v+WW2lvu955fZWu73D2JoZbm1rOd7vud/1nz/ANi953v+SvM3FpcFVpzv3vc7czrdve935nS6e9/vzOl0977fmdPp7n2/M6fT3ft+Z06nu/f9zpxOd+/7nTmd7t73O3M63b3vd+Z0unvf78zpdPe+35nT6e59vzOn0937fmdOp7v3/c6cTnfrfwsWbHiBnu/5xZ30/PL5dPNVQcxF88ySF3LumSUv5NwzS17IuWeWvJBzzyx5IeeeWfJCzj2z5IWce2bJCzn3zJIXcu6ZJS/k3DNLXsi5Z5a8kHPPLHkh555Z8kLOPbPkhZz7OeeFhUUpeGbJM0+eWfLMk2eWPPPkmSXPPHlmyTNPnlnyzJNnljzz5Jklzzx5ZskzT55Z8syTZ5Y88+SZJc88eWbJM0+eWfLMk2eWPPPk51wXSjIX0fGMzvFuyugc76aMzvFuyugc76aMzvFuyugc76aMzvFuyugc76aMzvFuyugc76aMzvFuyugc76aMzvFuyugc76aMzvGuZze+pP6G0io9//W357/7NXr+6+9L5zVQDVWOc1WHva1501wJ7UG1C5XjXNVhr8z1MAehVPnUGTn3TXN1Rvvhzn3qjJz7D0YFd/R6rnxy9HxumqtS7Udy9HqufHL0eM4Fz4lc6inznMix2zRXxXcj5UQu9ZR5TuQ+e9+lZ4586j4y3zRXxnfDM0f+KfNJrr2ASL1755vmylQ74XniGfN3/QDIkarjOV3TNL9T7YjndKTqeE63oCql3O9V7575prky3AnuRcr9/oz5xQ+AXrR64bXskfln4WfkdFKHmTud1KlIZ62X8q0ZT5XrjPyW16ZLfb/rsLuF6ow857eQzha3l2ofmMutZY/M/2F+ACZ0kpvQSW4iOZ3qvoZOdfdMx910Uj/diU5yEzpVpvMsr6P7Peg8ko3Q2ep0mD1KtQ/M5dayR+ZvLC4LrDjfve935nS6V/296CQ3oVO5Kp9OclvQqTKdNa9Tec06OslN6FSZzjP9o+g8klXoJDehs5btodoH3xXdve935nS6W/9bsGDDC+yefxY6yU3oJDcindRL6FSZzppPJ83zjOZTn8e97p7pVJ53Hva3ovNIVqHj9+kkX2V72Ls/u+argpiL5pklL+TcM38WOslN6CR3DzrJOTpVNjprXfdCp/JEx5+TT5lO5RM6yY3QeSSr0KkyncrvhbvA/RDe9dyfHTn3c84LC4tS8MySZ568u2egk9yETnIVOmtZhc7Wu2c67qaT+n7XkXN0tt4903nU34POI9kInXTXkauyR+EucD/SjiTnz6mT/JzrQknmIjqe0Tne9exZ+Bl1khuRTuol0km+ynQq7xlPleusvZbfeVKf5x6/FZ0q5/HOGulscXvRPmg3HO+mjM7xrmc3vqT+htIqe+eb5srs3Z+H5zVQDVWOc1WHva35u+CpnOciHXepz+d0OONz91CdqpPyKhsdzoyoDl3qp0xnq3s32oNqFyrHuarDXpnrYQ5CqfKpM3Luz4KOPyfv6FQZz8jLjdBJbgs6o1wnuS33Peg8klW5zqjzTkb74c596oyc+w9GBXf0eq58cvR8fic6o0yHnZHT4bNO5TU7Qie5Lejck+ls6e5F55GsynWYnYlqP5Kj13Plk6PHcy54TuRST5nnRI7dd6EzynTYGTkdPqcz8nw9oZPcFnTuyfywl7yO97agk7J02GO3ynm88058N1JO5FJPmedE7rP3XXrmyKfuI/PvZHS8w7mR06meddyvoZPcFnRSlo7P6KR5Zo+i80g2yh2d5N6B74ZnjvxT5pNcewGRevfOvxudUabDzsjpJM+T/JHo3JPpJJfue9B5JKtynUeyV1DthOeJZ8zf9QMgR6qO53RnQmeUVWfk3enu2ehwxuceQeeeTGfNp8OZLejsyXRGbjr07Hh+NNWOeE5Hqo7ndAuqUsr9XvXumW+aK8Od4F6k3O/PmF/8AMyhleXWskfmm+bKVPvAXG4te2S+fwCa5o1U+8Bcbi17ZP7G4rLAivPd+35nTqd71W+aK1Ltg++K7t73O3M63a3/LViw4QV2zzfNldm7P7vmq4KYi+aZJS/k3DNvmqvCXeB+CO967s+OnPs554WFRSl4ZskzT95d01wR7gL3I+1Icv6cOsnPuS6UZC6i4xmd413PmubKaB+0G453U0bneNezG19Sf0Nplb3zTXNl9u7Pw/MaqIYqx7mqw97WvGmuhPag2oXKca7qsFfmepiDUKp86oyc+5/Ev/7yp+H9J/Hrn3+OpO5Z+CN9/mS0H+7cp87Iuf9gVHBHr+fKJ0fP559A+sIx0/PZF+njTAuvv3y+nTRzBv4on79T7Udy9HqufHL0eM4Fz4lc6inznMix+5PQl236m76EzM6Gln70fHZ+8uef8N1IOZFLPWWeE7nP3nfpmSOfuo/M/wS4HPriEeX8e0aqpefzGeF74+culPPvT8F3wzNH/inzSa69gEi9e+d/EvyCVfjM2Zje48f5XPiZ2zn7+9f702ed8JmzU+2E54lnzN/1AyBHqo7ndD8NfbH4JdPzxLRA7qZM82fh432tHP0znAl+rv488VM+/0S1I57TkarjOd2CqpRyv1e9e+Z/AvpyCX7hRll6rXeh96TjXufM7138xM+/gjvBvUi5358xv/gB0ItWL7yWPTJ/dvRF8i+X0BfvzF9AvR8dPuu4n0iv9Wr0PvSenJ/w+Y+o9oG53Fr2yHz/AKygL5J/ufyLN/31L6G/1jvge+Jy+4md22x6zVcyvQ/9Jfzc9Zf/rBP+Wmek2gfmcmvZI/M3FpcFVpzv3vc7czrdq/4Z4RdK+JfOmZxm/fVejd6P4yd2brPpNV9J9b70NzE5zfrrnZFqH3xXdPe+35nT6W79b8GCDS+we/7M6Esnvn3hpvP5LM9+es1Xkt6PnnWS+/C3Wb7WO+D70XtaMJ3PZ3n202uejb37s2u+Koi5aJ5Z8kLOPfOzoy/T/KWb0BfP/9442xfQ3w/vJHXPgN6PPt/F5+1/b5zxn6GCu8D9EN713J8dOfdzzgsLi1LwzJJnnry7M/PtC5jOib98/p54J6l7BvR+furnP4K7wP1IO5KcP6dO8nOuCyWZi+h4Rud417OfwuqX8ORfQL0fvr8Eu2dC7++nfv4V2gfthuPdlNE53vXsxpfU31BaZe/82eEXa/4SAvqJ9BpnwN+nk2bOAN/jT/78K/buz8PzGqiGKse5qsPe1vzs+BeNpP6Z0Pv0pfF7mj0Leo+J1D872oNqFyrHuarDXpnrYQ5CqfKpM3Lum+bqjPbDnfvUGTn3H4wK7uj1XPnk6PncNFel2o/k6PVc+eTo8ZwLnhO51FPmOZFjt2muiu9Gyolc6inznMh99r5Lzxz51H1kvmmujO+GZ478U+aTXHsBkXr3zjfNlal2wvPEM+bv+gGQI1XHc7qmaX6n2hHP6UjV8ZxuQVVKud+r3j3zTXNluBPci5T7/Rnzix+AObSy3Fr2yHzTXJlqH5jLrWWPzPcPwIX5x19z3ryOah+Yy61lj8zfWFwWWHG+e9/vzOl0r/rN65iWXyTfvI5qH3xXdPe+35nT6W79b8GCDS+we755Pf0DcB727s+u+aog5qJ5ZskLOffMm9fTPwDngLvA/RDe9dyfHTn3c84LC4tS8MySZ568u+a19A/AOeAucD/SjiTnz6mT/JzrQknmIjqe0Tne9ax5D/0DcA60D9oNx7spo3O869mNL6m/obTK3vnmtfQPwLnYuz8Pz2ugGqoc56oOe1vz5jX0D8A50B5Uu1A5zlUd9spcD3MQSpVPnZFz37yP/gE4B6P9cOc+dUbO/Qejgjt6PVc+OXo+N6+nfwDOQbUfydHrufLJ0eM5FzwncqmnzHMix27zWvoH4Dz4bqScyKWeMs+J3Gfvu/TMkU/dR+ab1/H3/9SkfnM8vhueOfJPmU9y7QVE6t0737wWLbr+h0AnmDevpdoJzxPPmL/rB0COVB3P6Zr30//mPwfVjnhOR6qO53QLqlLK/V717plv3oP/N4DmPXAnuBcp9/sz5hc/AHNoZbm17JH55j30fwM4B9U+MJdbyx6Z7x+Apnkj1T4wl1vLHpm/sbgssOJ8977fmdPpXvWb5opU++C7orv3/c6cTnfrfwsWbHiB3fNNc2X27s+u+aog5qJ5ZskLOffMm+aqcBe4H8K7nvuzI+d+znlhYVEKnlnyzJN31zRXhLvA/Ug7kpw/p07yc64LJZmL6HhG53jXs6a5MtoH7Ybj3ZTROd717MaX1N9QWmXvfNNcmb378/C8BqqhynGu6rC3NW+aK6E9qHahcpyrOuyVuR7mIJQqnzoj575prs5oP9y5T52Rc//BqOCOXs+VT46ez01zVar9SI5ez5VPjh7PueA5kUs9ZZ4TOXab5qr4bqScyKWeMs+J3Gfvu/TMkU/dR+ab5sr4bnjmyD9lPsm1FxCpd+9801yZaic8Tzxj/q4fADlSdTyna5rmd6od8ZyOVB3P6RZUpZT7verdM980V4Y7wb1Iud+fMb/4AZhDK8utZY/MN82VqfaBudxa9sh8/wA0zRup9oG53Fr2yPyNxWWBFee79/3OnE73qt80V6TaB98V3b3vd+Z0ulv/W7Bgwwvsnm+aK7N3f3bNVwUxF80zS17IuWfeNFeFu8D9EN713J8dOfdzzgsLi1LwzJJnnry7prki3AXuR9qR5Pw5dZKfc10oyVxExzM6x7ueNc2V0T5oNxzvpozO8a5nN76k/obSKnvnm+bK7N2fh+c1UA1VjnNVh72tedNcCe1BtQuV41zVYa/M9TAHoVT51Bk5901zdUb74c596oyc+w9GBXf0eq58cvR8bpqrUu1HcvR6rnxy9HjOBc+JXOop85zIsds0V8V3I+VELvWUeU7kPnvfpWeOfOo+Mt80V8Z3wzNH/inzSa69gEi9e+eb5spUO+F54hnzd/0AyJGq4zld0zS/U+2I53Sk6nhOt6AqpdzvVe+e+aa5MtwJ7kXK/f6M+cUPwBxaWW4te2S+aa5MtQ/M5dayR+b7B6Bp3ki1D8zl1rJH5m8sLgusON+973fmdLpX/aa5ItU++K7o7n2/M6fT3frfggUbXmD3fNNcmb37s2u+Koi5aJ5Z8kLOPfOmuSrcBe6H8K7n/uzIuZ9zXlhYlIJnljzz5N01zRXhLnA/0o4k58+pk/yc60JJ5iI6ntE53vWsaa6M9kG74Xg3ZXSOdz278SX1N5RW2TvfNFdm7/48PK+BaqhynKs67K3lVW8rV59/N+/+5/+p85qrZivHuarDXpnrYQ5CqfKpM3Luq17qTPR8zt/N3vd/5fnRrDv3qTNy7j8YFdzR67nyydHr2b1Qj/3kmBN2vFflhB3vVTlhx3tVTtjxnrt3wvdFRr0qJ+x4r8oJO96rcsKO96qcsOO9Kl9z9HqufHL0eM4Fz4lc6inznMiNenLt1/27WXt/7bf7KidyqafMcyL32fsuPXPkU3fvvJBrv+7fzdr7a7/dj2aE/FPmk1x7AZF6986PXqPyovKcTV5UnrPJi8pzNnlRec4mL7z3Ltbel3tRec4mLyrP2eRF5TmbvKg8Z5MXo1nPE8+Yv+sHQI5UHc/pnLVu8hM9fw7W3lvyEz2fs2pGjlQdz+kWVKWU+73q3TOfuu3v8+9m7f21r/09ud+fMb/4AZhDK8utZXvnnZGv/nPIFeYTf/9PJnX3kt6bGPme/+6Vpbkt2SPzP/IHQP8ZPf+dtPgkzewhvT9R+Z7P81Uut5Y9Mn9jcVlgxfnufb8zp9O9ysjIy/X8F7/++eePv2npCbvPIL2/iZHv+SUpU06nu/f9zpxOd+t/CxZseIGnzDvtt/uJaanTwiee+QMwsfb+2q973gndIfNVQcxF88ySF3Luq3yrn+j5L6al/sdf88KTqXOGH4CJnv/6W/Xk3DNLXsi5n3NeWFiUgmeWPPPkU0Y4R7zDO/E54R3eic8J7/BOfE54h3fic6LqTEutH4H0Q6BcPc7uge+HpO6Ed3gnPie8wzvxOeEd3onPCe/wTnxOeIddOubJM0ueefJzrgslmYvoeEbneNcz5sknt6Uzcls6I7elM3JbOiPnHcEfAP4IMHvm8ov0HkduS2fktnRGbktn5LZ0Ro4dZgn12PGMzvGuZze+pP6G0ip75tn3ed3XOiNXZbyPXJXxPnJVxvvIVZnuQkvPhSdyPreX0XvTfa0zclXG+8hVGe8jV2W8j1yV6a6sclt4eF4D1VDlOFd12Kty4h32qpx4h70qJ95hr8qJd9ircuId9rbkXPQKdTi3B72P9B7pq5x4h70qJ95hr8qJd9ircuId9qqceIe9KifeYa/M9TAHoVT51Bk596kzcu5TZ+Tcp87IuU+dkXOfOiPnnoz+739y5A+Avz937lNn5Nynzsi5T52Rc586I+c+dUbOfeqMnPsPRgV39HqufHL0eq58cvR6rnxy9HqufHL0eq58cvR6rnxy9Hye2PID8Ozln6jeX3L0eq58cvR6rnxy9HqufHL0eq58cvR6rnxy9HqufHL0eM4Fz4lc6inznMilnjLPiVzqKfOcyKWeMs+JXOop85zIpZ4yz4kcu9MPwAQX3dEPAeeegb+3lBO51FPmOZFLPWWeE7nUU+Y5kUs9ZZ4TudRT5jmRSz1lnhO5z9536Zkjn7o9//p5oQVfw+f24u/NM0e+508wn+TaC4jU6/nXzjv8Nz3hfxNIc49SvSfPEz2fs1fO3/UDIEeqjud0pOp4Tkeqjud0pOp4Tkeqjud0pOp4TreGLzqXn/kzqN6j53Sk6nhOR6qO53Sk6nhOR6qO53Sk6nhOR6qO53QLqlLK/V71ej7nfn/G/FaOWP4J/jOt/XP5ved/fyaj3O/753/79f8DeJnRK8fF4AAAAABJRU5ErkJggg==" alt="">
</section>
<section id="setup">
<h2 class="heading">First things first...</h2>
<ul>
<li>
Crack open your favorite text editor (might we recommend <a href="https://code.visualstudio.com/" target="_blank" rel="noopener noreferrer">Visual Studio Code</a>?)
</li>
<li>Split your screen between your text editor and preferred web browser</li>
<li>Keep your terminal close by</li>
</ul>
</section>
<section id="pages">
<h2 class="heading">Pages</h2>
<p>By default, the homepage of a Puppy project is the prototype <strong>index</strong>. It lists every page in your prototype. You can see it <a href="/" target="_blank" rel="noopener noreferrer">here</a>.</p>
<h3>In this section you'll learn how to...</h3>
<ul>
<li>Create your first page</li>
<li>Give it a name</li>
<li>Leverage the power of <a href="https://twig.symfony.com/" target="_blank" rel="noopener noreferrer">Twig</a></li>
<li>Reference an asset in the <code>/public/</code> directory</li>
<li>Separate your content from the presentation layer</li>
</ul>
<h3>Create your first page</h3>
<p>Pages live in the <code>/src/pages/</code> directory.</p>
<p>It only seems fitting for our first page to be about puppies! First, create a new file in the <code>/src/pages</code> directory called <code>puppies.html</code>.</p>
<h3>Give it a name</h3>
<p>You can give your page metadata with YAML front matter headers. They look a little something like this:</p>
<pre>
---
title: My Puppy Page
tags:
- Adorable
- Floofy
---
</pre>
<br>
<p>The name of your page can be defined with the <code>title</code> attribute. Now, if you return to the <a href="/" target="_blank" rel="noopener noreferrer">index</a>, you’ll see a link to your new page!</p>
<h3>Leverage the power of Twig</h3>
<p>So, our page has a name…but it still doesn’t have any content. To start adding content, we can use <a href="https://twig.symfony.com/" target="_blank" rel="noopener noreferrer">Twig</a> syntax to create flexible page templates.</p>
<p>We’ve provided a simple page layout template under <code>/src/templates/layouts</code> called <code>base.twig</code>. Now, in <code>puppies.html</code>, you can extend this template and immediately start adding content like so:</p>
<pre>
<code>
<!-- in puppies.html -->
{{ "{% extends "@templates/layouts/base.twig" %}" }}
{{ "{% block content %}" }}
<div class="puppy-page">
<h1 class="puppy-page__heading">My Puppy Page</h1>
<p>A captivating description</p>
<!-- Rest of content -->
</div>
{{ "{% endblock %}" }}
</code>
</pre>
<br>
<p>Check out your page to see your new content!</p>
<h3>Reference an asset in the <code>/public/</code> directory</h3>
<p>Any static images or assets you wish to use on your site can be moved to the <code>/public/static</code> directory.</p>
<p>From there, you can call the built-in function <code>puppy.staticUrl('path/to/file')</code> in your page template to display the asset.</p>
<p>Let's see how this works by adding this adorable face to our <code>puppies.html</code> page:</p>
<img src="https://picsum.photos/id/237/300/300" alt="A puppy"/>
<br>
<br>
<p>To get the above photo as a file in your project, run this command in a new terminal tab/window at the project root:</p>
<code>curl -L https://picsum.photos/id/237/300/300 > public/static/img/puppy.jpg</code>
<br>
<br>
<p>You should now see the image in the <code>/public/static/img</code> directory. Here's how we can reference this image in our page template:</p>
<pre>
<code>
<!-- in puppies.html -->
{{ "{% extends "@puppy/layouts/base.twig" %}" }}
{{ "{% block content %}" }}
<div class="puppy-page">
<h1 class="puppy-page__heading">My Puppy Page</h1>
<p>A captivating description</p>
<!-- Reference your image here -->
<img class="puppy-page__img"
src={{ "{{ puppy.staticUrl('img/puppy.jpg') }}" }} />
</div>
{{ "{% endblock %}" }}
</code>
</pre>
<br>
<p>You should now see the image on your page. Easy, right?</p>
<h3>Separate markup and content with data</h3>
<p>Now we know how to easily add content to a page. But what if we want to avoid hardcoding that content in our template markup?</p>
<p>Have no fear! Puppy allows you to <strong>easily separate your content from the presentation layer.</strong></p>
<p>Any structured data you want your page to access can live in the <code>/src/data</code> directory.</p>
<p>Let's enhance our puppy page a bit by adding a list of dog breeds. This example will use a JSON data file, but Puppy also supports YAML and JavaScript data files. To start, we can create a new <code>dog-breeds.json</code> file in <code>/src/data</code>:</p>
<pre>
<code>
// dog-breeds.json
[
{ "name": "Shiba Inu",
"link": "https://en.wikipedia.org/wiki/Shiba_Inu"
},
{ "name": "Welsh Corgi",
"link": "https://en.wikipedia.org/wiki/Welsh_Corgi"
},
{ "name": "Labrador Retriever",
"link": "https://en.wikipedia.org/wiki/Labrador_Retriever"
}
]
</code>
</pre>
<br>
<p>Conveniently, all our data files can be accessed through a global <code>site.data</code> array. All we have to do is <a href="https://twig.symfony.com/doc/3.x/tags/for.html" target="_blank" rel="noopener noreferrer">loop</a> through <code>site.data['dog-breeds.json']</code>.</p>
<pre>
<code>
<!-- in puppies.html -->
<h2>Dog Breeds</h2>
<ul>
{{ "{% for breed in site.data['dog-breeds.json'] %}" }}
<li><a href={{ "{{ breed.link }}" }}>{{ "{{ breed.name }}" }}</a></li>
{{ "{% endfor %}" }}
</ul>
</code>
</pre>
<br>
<p>If you visit your page now, you should see a list of breeds populated from your data!</p>
<br>
<p>Congrats! Now you have all the tools you need to create a basic page in your prototype. 🎉</p>
<p>But we're just getting to the fun stuff - let's see how we can spruce up our page a bit with some styling!</p>
</section>
<section id="styles">
<h2 class="heading">Styles</h2>
<h3>In this section you'll learn how to...</h3>
<ul>
<li>Add a Sass file</li>
<li>Link to a static asset (font, background image)</li>
</ul>
<h3>Add a Sass file</h3>
<p>We enjoy using <a href="https://sass-lang.com/" target="_blank" rel="noopener noreferrer">Sass</a> for CSS preprocessing so much that Puppy supports <code>.scss</code> compiling by default!</p>
<p>This means adding styles to your page is as simple as creating a new <code>.scss</code> file in the <code>/src/scss</code> directory.</p>
<p>Currently in <code>/src/scss</code> we have:</p>
<ul>
<li><code>main.scss</code> - main stylesheet for your prototype that imports any individual stylesheets</li>
<li><code>tutorial.scss</code> - styles for this tutorial page</li>
<li><code>reset.scss</code> - styles to clear browser defaults</li>
</ul>
<br>
<p>Ready to give your puppy page a makeover? Start by creating a new file called <code>puppies.scss</code> and placing it in <code>/src/scss</code>.</p>
<pre>
<code>
// in puppies.scss
.puppy-page {
margin: 50px;
}
.puppy-page__heading {
font-size: 48px;
}
// any additional styling
</code>
</pre>
<br>
<p>If you visit your <code>puppies.html</code> page...nothing has changed. That's because you need to import <code>puppies.scss</code> in <code>main.scss</code>!</p>
<pre>
<code>
// Path to static assets
$publicPath: '/';
// Project styles go here
@import 'puppies'; // Add this line
</code>
</pre>
<br>
<p>Hit save and now visit your page. All your new styles should be applied! ✨</p>
<h3>Link to a static asset</h3>
<p>In case you need to include any static assets in your SCSS files, you can drop those assets in the <code>/public/static</code> directory. We've provided a global variable called <code>$publicPath</code> in <code>main.scss</code> where you can set the path to your <code>public</code> directory.</p>
<p>For example, you can add custom web fonts to <code>/public/static/fonts</code> and import them into your stylesheets like so:</p>
<pre>
<code>
@font-face {
font-family: 'My Custom Font';
src: url($publicPath + 'static/fonts/my-custom-font.woff2') format('woff2');
font-style: normal;
font-weight: 400;
}
</code>
</pre>
</section>
<section id="scripts">
<h2 class="heading">Scripts</h2>
<h3>In this section you'll learn how to...</h3>
<ul>
<li>Add a Javascript file</li>
<li>Install and import a third party dependency</li>
</ul>
<h3>Add a Javascript file</h3>
<p>Similar to adding styles, you can add <code>.js</code> files to the <code>/src/js</code> directory that this starter comes with.</p>
<p>Let's try this out by adding a file called <code>puppy-alert.js</code> that simply shows an alert every time our image of a puppy is clicked.</p>
<pre>
<code>
// in puppy-alert.js
document.querySelector('.puppy-page__img')
.addEventListener('click', () => alert('🐶'));
</code>
</pre>
<br>
<p>Before we can test our changes, we need to import our file in the provided <code>main.js</code> file in the <code>/src/js</code> directory.</p>
<pre>
<code>
// in main.js
import './puppy-alert';
</code>
</pre>
<br>
<p>Once that's done, our new JavaScript changes will be loaded on the page!</p>
<h3>Install and import a third party dependency</h3>
<p>You can add any third-party modules available on <a href="https://www.npmjs.com/" target="_blank" rel="noopener noreferrer">NPM</a> to your Puppy project by running <code>npm install <module-name></code>.</p>
<p>To use the installed module, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import" target="_blank" rel="noopener noreferrer">import</a> it wherever needed. For example:</p>
<pre>
<code>
import $ from 'jquery';
</code>
</pre>
</section>
<section id="deployment">
<h2 class="heading">Deployment</h2>
<p>Ready to share your work with the rest of the world? Puppy can generate a static site for you, which means it's super easy to deploy your prototype to a live web server - one of our top picks is <a href="https://www.netlify.com/" target="_blank" rel="noopener noreferrer">Netlify</a>!</p>
<h3>Deploy to Netlify</h3>
<p>When it comes to <a href="https://docs.netlify.com/site-deploys/create-deploys" target="_blank" rel="noopener noreferrer">deploying</a> with Netlify, you have some options:</p>
<h4>Deploy with Git (CD)</h4>
<p>If your site has a Git repository, you can link it to Netlify and <a href="https://docs.netlify.com/configure-builds/get-started/#basic-build-settings" target="_blank" rel="noopener noreferrer">configure the build settings</a> for CD (Continuous Deployment).</p>
<p>To add CD to your Puppy site, you can update your Netlify build settings to this:</p>
<ul>
<li>Build command: <code>npm run build</code> - this builds your static site</li>
<li>Publish directory: <code>dist</code> - this is where your static site lives</li>
</ul>
<br>
<p>If your project isn't at the root of your repository, you will need to update the "Base directory" and "Publish directory" settings to include the path to your project.</p>
<h4>Deploy with CLI</h4>
<p>You can also use the <a href="https://docs.netlify.com/cli/get-started" target="_blank" rel="noopener noreferrer">Netlify CLI</a> tool to manually trigger deploys.</p>
<p>Set up your project with these commands:</p>
<pre>
<code>
npm install netlify-cli -g # Install netlify-cli
netlify login # Authenticate your Netlify account
netlify init # Initialize repo at project root
</code>
</pre>
<br>
<p>Whenever you're ready to deploy, you can run:</p>
<pre>
<code>
npm run build # Build your static site
netlify deploy --dir=dist # Deploy the dist directory
</code>
</pre>
<br>
<br>
<p>That's it! Now your Puppy site is live on the World Wide Web. 💥</p>
</section>
<section id="outro">
<h2 class="heading">So long, for now!</h2>
<p>Thanks for spending the past 15 minutes with us!</p>
<p>Feel free to leave this page here to refer back to while you're getting your bearings.</p>
<p>When you're confident you've absorbed everything here you can <strong>remove this tutorial</strong> by:</p>
<ul>
<li>Remove the line importing <code>tutorial.scss</code> from <code>/src/scss/main.scss</code></li>
<li>Remove the entrypoint for <code>tutorial.scss</code> in <code>webpack.config.js</code> (<a href="https://github.com/Upstatement/puppy/blob/main/webpack.config.js#L12">line 12</a>)</li>
<li>Delete <code>/src/scss/tutorial.scss</code> itself</li>
<li>Delete <code>/src/pages/tutorial.html</code> (this page!)</li>
</ul>
</section>
</main>
</div>
{% endblock %}
{% block footer %}
<footer class="footer">
<a href="https://upstatement.com" target="_blank"><img class="logo" src="{{ puppy.staticUrl('img/ups-logo.svg') }}" alt="Upstatement"></a>
</footer>
{% endblock %}
{% block scripts %}
<script type="text/javascript">
const navList = document.querySelector('.sidebar__items');
const sections = Array.from(document.querySelectorAll('section'));
sections.forEach(section => {
// Sidebar nav items
const navItem = document.createElement('li');
const navLink = document.createElement('a');
navLink.textContent = section.id;
navLink.setAttribute('href', `#${section.id}`);
navItem.appendChild(navLink);
navList.appendChild(navItem);
// Section heading anchors
const heading = section.querySelector('.heading');
const headingAnchor = document.createElement('a');
headingAnchor.textContent = '#';
headingAnchor.setAttribute('href', `#${section.id}`);
headingAnchor.classList.add('heading__anchor');
heading.appendChild(headingAnchor);
})
// Active sidebar links
onHashChange();
window.addEventListener('hashchange', () => onHashChange(), false);
function onHashChange() {
const navLinks = Array.from(document.querySelectorAll('.sidebar li a'));
navLinks.forEach(l => l.classList.remove('active'));
const { hash } = window.location;
const activeNavLink = navLinks.find(l => l.hash === hash);
if (!activeNavLink) {
return;
}
activeNavLink.classList.add('active');
}
</script>
{% endblock %}>