Let's Code: Test-Driven Javascript

"Let's Code: Test-Driven Javascript" is a screencast series focusing on rigorous, professional web development. For more information, visit http://letscodejavascript.com .

This repository contains the source code for WeeWikiPaint, the application being developed in the series.

(Wondering why we check in things like node_modules or IDE settings? See "The Reliable Build".)

Before building or running for the first time:

1. Install Node.js
2. Install Git
3. Install Firefox (for smoke tests)
4. Clone source repository: git clone https://github.com/jamesshore/lets_code_javascript.git
5. All commands must run from root of repository: cd lets_code_javascript

Note: If you update the repository (with git pull or similar), be sure to erase generated files with git clean -fdx afterwards. (Note that this will erase any files you've added, so be sure to check in what you want to keep first.)

A note about Node versions:

Some episodes' source code was written for old versions of Node. You can check which version of Node the code expects by looking at the engines.node property in package.json. (That file didn't exist prior to episode 31. Those episodes expected v0.6.17, 0.8.4, or 0.8.6; any should work.)

If you're having trouble getting the code to work properly, especially if the code expects Node 0.8 or earlier, try installing the exact version of Node the code expects. Convenient tools for changing Node versions include nvm and n on Mac/Linux, and nvmw and nodist on Windows.

Known version issues:

• A few episodes rely on a feature of Node.js streams that was removed in Node 0.10. A workaround is included in the video for the episodes in question.
• Early versions of Jake don't work on Node 0.10+. You might be able to resolve this problem by running npm install jake.
• Early versions of NodeUnit use an internal 'evals' module that was removed in Node 0.12. (See Node.js issue #291.) You might be able to resolve this problem by running npm install nodeunit.
• Node 0.12 changed the behavior of server.close() when the server is already closed. In previous versions, it threw an exception, but now it passes an err object to the server.close callback. This breaks one of the server tests. You can just delete the test in question, or see episode 14 for a workaround.

To build and test:

1. Run ./jake.sh karma (Unix/Mac) or jake karma (Windows)
2. Navigate at least one browser to http://localhost:9876
3. Run ./jake.sh loose=true (Unix/Mac) or jake loose=true (Windows)

You can also run ./jake.sh quick loose=true for a faster but less thorough set of tests.

Note: The master branch is not guaranteed to build successfully. For a known-good build (tested on Mac and Windows, and assumed to work on Linux), use the integration branch:

1. Change to the integration branch: git checkout integration
2. Erase generated files: git clean -fdx (Note that this will erase all new files, so be sure to check in anything you want to keep.)
3. Stop Karma, if it's running
4. Build using the steps above
5. To change back to the development branch, follow these steps again using git checkout master

To run locally:

1. Run ./jake.sh run (Unix/Mac) or jake run (Windows)
2. Navigate a browser to http://localhost:5000

Note: The master branch is not guaranteed to run successfully. For a known-good build, use the integration branch as described above.

Before deploying for first time:

1. Make sure code is in Git repository (clone GitHub repo, or 'git init' yours)
2. Install Heroku Toolbelt
3. Sign up for a Heroku account
4. Run heroku create <app_name> (requires git repository and Heroku account)
5. Search codebase for weewikipaint.herokuapp.com URLs and change them to refer to <app_name>
6. Push known-good deploy to Heroku: git push heroku episode200:master

To deploy:

1. Run ./jake.sh deploy (Unix/Mac) or jake deploy (Windows) for instructions

Note: The master and integration branches are not guaranteed to deploy successfully. The last known-good deploy was commit 85c35e5ce5387d2814ceeb849e39eee8e5c1847e. We'll establish better deployment practices in a future chapter of the screencast.