Skip to content

Installing the Project

Sam Matthews edited this page May 12, 2015 · 8 revisions

TODO: Write Instructions for PC/Linux

To run this project on Mac:

  1. Node & npm - please start by installing Node from their website package. This includes npm (Node Package Manager)
  2. Git - install Git, our version control language that allows us to record a history of every change made to the code base.
  3. Fork the project on github into your own repository.
  4. Clone project - open terminal and navigation (cd) to where you want the project to exist in your computer. Then grab the URL to clone your forked version of the project and run git clone https://github.com/YOUR-USERNAME/drop-n-chop.git. Once that has successfully been created, you can cd drop-n-chop to the directory.
  5. Initialize dependencies by running npm install (this may require sudo npm install to access your admin root). This will install all of the necessary projects
  6. Grunt / Build your project - Grunt is the task manager that allows us to run special operations to our code base before we load the page. Things like javascript minification, SASS building, and testing, run through this task. To build your project, enter grunt into your terminal and watch the magic happen. You should see something like this:
Running "jshint:files" (jshint) task
>> 12 files lint free.

Running "concat:dist" (concat) task
File dist/js/L.DNC.js created.

Running "uglify:app" (uglify) task
>> 1 sourcemap created.
>> 1 file created.

Running "karma:unit" (karma) task
......................................................
PhantomJS 1.9.8 (Mac OS X): Executed 54 of 54 SUCCESS (0.095 secs / 0.019 secs)

Running "sass:dist" (sass) task

Running "processhtml:dev" (processhtml) task

Running "connect:dev" (connect) task
Started connect web server on http://0.0.0.0:8000

Running "focus:dev" (focus) task

Running "watch" task
Waiting...

Your version of the project has been built successfully and passed all of the tests we've written. Congrats! Head to localhost:8000 in your browser to see it work.

Clone this wiki locally