Skip to content

Commit 59fac53

Browse files
author
David Needham
committed
Updating the standalone example app
1 parent 19dab49 commit 59fac53

File tree

2 files changed

+13
-52
lines changed

2 files changed

+13
-52
lines changed

index.html

Lines changed: 13 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h2>Setup</h2>
8989
<li>Windows users also need <a href="https://www.python.org/downloads/">Python</a> installed</li>
9090
</ul>
9191
<li><a href="https://github.com/garris/BackstopJS">BackstopJS</a> installed globally<ul><li><code>npm install -g backstopjs</code></li></ul></li>
92-
<li>Our <a href="https://github.com/davidneedham/Visual-Regression-Testing-BackstopJS-demo.git">standalone Node.js app</a></li>
92+
<li>The <a href="https://github.com/davidneedham/visual-regression-testing-workshop"> Node.js example app</a></li>
9393
<li>A “live” website that is web-accessible</li>
9494
<li>A “dev” version of that same website (local is great)</li>
9595
</ul>
@@ -406,22 +406,22 @@ <h2>Standalone App</h2>
406406
<section class="slide image-r">
407407
<div class="text">
408408
<h2>Clone the example repo</h2>
409-
<p>We've created <a href="https://github.com/davidneedham/Visual-Regression-Testing-BackstopJS-demo.git">an example repo</a> that we're going to clone to give you a jumpstart.</p>
409+
<p>We've created <a href="https://github.com/davidneedham/visual-regression-testing-workshop">an example repo</a> that we're going to clone to give you a jumpstart.</p>
410410
<p>There are detailed instructions in the README to run through this on your own next time. </p>
411411
<p>Today we're going to get started by cloning the repo:</p>
412412
</div>
413413

414-
<code class="block">git clone https://github.com/davidneedham/Visual-Regression-Testing-BackstopJS-demo.git</code>
414+
<code class="block">git clone https://github.com/davidneedham/visual-regression-testing-workshop</code>
415415
<figure>
416416
<img class="cover" src="pictures/24-screencapture-github-davidneedham-Visual-Regression-Testing-BackstopJS-demo-2018-05-30-19_02_53.jpg" alt="A screenshot of the repo we're cloning">
417417
</figure>
418418
</section>
419419

420420
<section class="slide">
421421
<div class="text">
422-
<h2>Running the example</h2>
422+
<h2>Running the example node app</h2>
423423
<ol>
424-
<li>Change into the folder <br /><code>cd Visual-Regression-Testing-BackstopJS-demo</code></li>
424+
<li>Change into the folder <br /><code>cd visual-regression-testing-workshop</code></li>
425425
<li>Checkout a new branch <br /><code>git checkout -b my-hacking-1</code></li>
426426
<li>Install Node dependencies <br /><code>npm install</code></li>
427427
<li>Run the example script <br /><code>npm run start</code></li>
@@ -432,56 +432,17 @@ <h2>Running the example</h2>
432432

433433
<section class="slide">
434434
<div class="text">
435-
<h2>Hacking the example</h2>
436-
<ol>
437-
<li>Edit <code>includes/backstop.json</code></li>
438-
<li>Rerun the script with <code>npm run start</code></li>
439-
</ol>
440-
</div>
441-
</section>
442-
443-
<section class="slide">
444-
<div class="text">
445-
<h2>Running the multiple site example (pt 1)</h2>
446-
<ol>
447-
<li>Commit your existing changes<br /><code>git commit -am "All of my changes"</code></li>
448-
<li>Checkout the branch<br /><code>git checkout multiple-sites</code></li>
449-
<li>Checkout a new branch to work on<br /><code>git checkout -b my-hacking-2</code></li>
450-
<li>Re-install Node dependies<br /><code>npm install</code></li>
451-
<li>Rerun the example script<br /><code>npm run start</code> (and type a site name from the list when prompted)</li>
452-
<li>Wait for the results</li>
453-
</ol>
454-
</div>
455-
</section>
456-
457-
<section class="slide">
458-
<div class="text">
459-
<h2>Running the multiple site example (pt 2)</h2>
460-
<ol>
461-
<li>Run the command <code>npm run start -- --all</code> (note the extra <code>--</code>)</li>
462-
<li>Wait for the results (from multiple sites!)</li>
463-
<li>Edit <code>includes/sitesToUpdate.js</code> (list of sites to test)</li>
464-
<ul>
465-
<li>Try changing to one (or more) of your sites</li>
466-
<li><code>BackstopReferenceBaseUrl</code> is your local / development URL</li>
467-
<li><code>BackstopTestUrl</code> is your production site URL</li>
468-
<li><code>pathsToTest</code> is the array of URIs to test for each site</li>
469-
</ul>
470-
</ol>
471-
</div>
472-
</section>
473-
474-
<section class="slide">
475-
<div class="text">
476-
<h2>Running the multiple site example (notes)</h2>
435+
<h2>Customizing the example</h2>
477436
<ul>
478-
<li><code>npm run start</code> tests a single site</li>
479-
<li>Add <code> -- --site=my-cool-site</code> to specify a site (no prompt)</li>
480-
<li><code>npm run start -- --all</code> tests all the sites in <code>includes/sitesToUpdate.js</code></li>
481-
<li>Backstop config doesn't have to be hard-coded JSON</li>
437+
<li>Edit <code>inc/sitesToTest.js</code> is the list of sites to test</li>
482438
<ul>
483-
<li>See <code>includes/backstopConfig.js</code> for a dynamic configuration example</li>
439+
<li>Try adding a section for your own site.</li>
440+
<li><code>nonProductionBaseUrl</code> is your local / development URL</li>
441+
<li><code>productionBaseUrl</code> is your production site URL</li>
442+
<li><code>pathsToTest</code> is the array of URIs to test for each site</li>
484443
</ul>
444+
<li>Edit <code>inc/backstopConfig.js</code> (the viewports, delay, etc)</li>
445+
<li>Re-run the demo with <code>npm run start</code></li>
485446
</ul>
486447
</div>
487448
</section>

0 commit comments

Comments
 (0)