This is the main README for the City Hero thing (known as ET below).

What is this?

City Hero is a site that makes the world a better place.

How to Install

1. Install node (needs link)
2. Install npm (needs link)
3. Clone this repository
4. cd city-hero
5. npm install (will make some time)
6. Create new lib/settings/auth.js file from lib/settings/auth.example.js
7. Run application: node lib/server.js

Coding Standards

• Crockford JavaScript Style Guide
• Commenting via JSDoc
• JSLint (node.js project)
  • To run JSLint from project base: node_modules/jslint/bin/jslint.js --white --onevar --regexp <APPLICATION_FILE>.js
• CSS ?
• HTML ?

Testing

• Currently trying Expresso
  • To run tests from project base: node_modules/expresso/bin/expresso test/<TEST_FILE>.js

Credits and Resources

• Node.js
• See package.json for dependencies

Deploy

• Currently using DotCloud
• See DotCloud Node.JS docs
• See npm package.json documentation
• Must listen on port 8080 for DotCloud

Tracking