##Getting setup to Build (updated 8/15/2014)## Note: If the last time you set up the project was before 7/11/2014, I recommend you clear out your old project setup and re-clone the repository

1. Install Mercurial. Download the package w/o TortoiseHg You won't need a gui, but if you want one, I recommend SourceTree. Install Eclipse Kepler. Optionally install The FindBugs Eclipse Plugin.
2. Make a new folder where you will clone the source code (e.g. screencasting). Navigate to this in a command prompt.
3. Clone https://bitbucket.org/klubick/screencasting-module to this new folder.
4. Clone this repo to the new folder.
5. Open Eclipse. Go to File>Import. Select General>Existing Projects into Workspace and choose the screencasting-module. Repeat for the screencasting local hub.
6. Browse to the folder /src/etc and make a copy of log4j.settings.default. Change this name to log4j.settings. This will affect the logging habits of your build. Feel free to change the .settings file as it is ignored by source control. If you need to set up logging in code (for example, if you make your own main method in a new class), call TestingUtils.makeSureLoggingIsSetUp(); to load the settings file. Repeat this process for /src/etc/EventForwarder.properties.default -- the default values are probably fine.
7. Run edu.ncsu.lubick.Runner to test everything is set up well.

###Setting up Web Development### If you will be interacting with the front end, you'll need to do a bit more setup. We use Bower to manage our dependencies for things like Angular.js, JQuery, Bootstrap, etc. Bower uses git to fetch dependencies, so you'll need to:

1. Install git. Remember to add this to your path and restart all shells to get git in there.
2. Install Node.js. This should include npm, the node package manager. Remember to add node and npmp to your path and restart all shells.
3. Install Bower by running npm install -g bower in a command line.
4. Navigate the shell to your folder from the earlier step 2 (screencasting) and then cd ../src/frontend/public_html.
5. Execute bower install. This will download all the dependencies from the bower.json file. This may take a while.
6. Refresh your ScreencastingLocalHub project in Eclipse. If you already have a server running, it should be smart enough to get the new files. Otherwise, open up chrome dev tools and enable Settings>Disable cache when DevTools is open, then hit Ctrl+F5 to force a full refresh.

Bower is not run automatically, so if you are getting an error about not being able to find a library/resource, it's probably because someone else added a new dependency. Try re-running steps 4-6.

###Adding a new dependency:###

1. Add an entry to bower.json - this will be the name of the git repository. If you aren't sure, try running bower search [whatever] in the command line to find the right package.
2. Execute bower install to download the package.
3. We need to tell require.js about the package. Navigate to main.js and add an entry of [moduleName] : '../lib/bower/path/to/executable'. leave off the .js, but include everything else.
4. Add a shim entry where you have module: [dependencies] (still in main.js)
5. In controllers.js (or whereever, add an entry to the define at the top of the module name (the same thing you typed in main.js)
6. Go ahead and inject the services you need (which may or may not be the same name as the module name)
7. Not working? Try adding an entry to the requirejs call at the bottom of main.js (it's still a bit magic at this point)

###Updating versions### If things seem buggy, try updating the javascript libraries with bower update

###Setting up Mocks:### In the working directory, extract the mocks.zip (Found under downloads). To activate "mock mode", append a ?mock=true to the url