nathanjd/js-app

Base for developing static Javascript apps.

js-app

A starting point and build environment for javascript applications deployed to Amazon S3.

How to Install and Run

Install NodeJS from http://nodejs.org/.

Download and install the GruntJS command line tool.

$ npm install -g grunt-cli

Cd to project directory, then download and install NodeJS packages.

$ npm install

Create compiled directory (compiles and watches source).

$ grunt

Run server.

$ node server

Open http://localhost:9090 in a web browser.

Development

Watch for and compile changes to source files.

$ grunt watch

Deployment

Grunt is used to compile and push the app to an s3 bucket. To deploy, a file named .aws.json containing your Amazon S3 authentication must be present at the project root.

.aws.json

{
  "key": "your_s3_key",
  "secret": "your_s3_secret"
}

Push to the bucket "my-bucket" by executing the grunt task "deploy" from the command line.

$ grunt deploy:my-bucket

Technologies Used

CSS

SASS - CSS Pre-processor
Bourbon - Grid Framework
Bourbon Neat - Responsive Framework

Javascript

RequireJS - Dependency Management

Crossroads - Routing
Hasher - URL Hash Management
Signals - Eventing

Lo-Dash - Utility
jQuery - DOM Interaction and AJAX
Handlebars - Templating

Mocha - Unit Testing
Chai - Assertions

Build & Development

NodeJS
GruntJS - Build System

Server Integration

Amazon S3
S3Ajax - Javascript S3 Library