Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 2.83 KB

README.md

File metadata and controls

78 lines (60 loc) · 2.83 KB

# DoggerJS Frontend

Build Status Dependency Status devDependency Status Code Climate

Prerequisite Technologies

Linux

  • Node.js - Download and Install Node.js, nodeschool has free node tutorials to get you started.

If you're using Ubuntu, this is the preferred repository to use...

$ curl -sL https://deb.nodesource.com/setup | sudo bash -
$ sudo apt-get update
$ sudo apt-get install nodejs
  • Git - Get git using a package manager or download it.

Windows

  • Node.js - Download and Install Node.js, nodeschool has free node tutorials to get you started.
  • Git - The easiest way to install git and then run the rest of the commands through the git bash application (via command prompt) is by downloading and installing Git for Windows

OSX

  • Node.js - Download and Install Node.js or use the packages within brew or macports.
  • git - Get git from here.

Prerequisite packages

  • DoggerJS currently works with gulp.
$ npm install -g gulp
// and bower
$ npm install -g bower

Installation

You just need to clone this repo and start your development.

$ git clone https://github.com/hashdog/doggerjs-frontend.git <my-app>
$ cd <my-app> && npm install

Running

DoggerJS supports the gulp task runner for various services which are applied on the code. To start compiling your application run:

$ gulp

This gulp task will compile your templates and sass files, optimize images, javascripts, css and create the public directory.

After that, you need to run the local server:

$ node server

Then, open a browser and go to:

http://localhost:8080

Testing

If you need to test your javascript code, just run:

$ gulp test

This task, will check all .js files and will notificate you about warnings and errors.