codeforamerica/city-hero

The City Hero, Engagement Toolkit, Engagikit, Togather, thing in node.js

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

city-hero's Issues

The Code for America link is broken in the template

"Created as Open Source by Code for America" is at the bottom of every page, but the CfA link goes to "#"

After registration via Facebook, the user is not automatically logged in.

They should be logged in automatically.

If the creator of a project is deleted from the db, the project page dies.

This should not happen. The project should be shown as ownerless or abandoned or something...

502 error when not allowing City Hero to access Facebook data

On the Request for Permission page, click the Don't Allow button, and you get a 502 error from nginx (dotcloud).

No hover effect on the login button on the login page

Tested in Chrome

Input style on login page is out of date

Needs to be the lighter gray and inset

Facebook says "Catalyze" is requesting permission

When creating an account using Facebook, the Request for Permission page says that Catalyze is asking for permission. Should be City Hero.

No hover effect on the search button on the home page

Tested in Chrome

Doctype is XHTML 1.0

Change the doctype from XHTML 1.0 to HTML 4 or 5 (or something more reasonable for a web app than XHTML1). Some things break in Safari because some of our img tags are unclosed, but shouldn't need to be.

Conflicting manual and FB usernames explode the site

To recreate:
Create an account manually. I used atogle b/c that's my FB account
Logout
Login via FB. The manual atogle account and new FB account don't get along.
You get redirected to a broken home page - no visible style.

Tested in Chrome.

Get Satisfaction dialog overlay doesn't overlay the whole page

Tested in Chrome

If a newly registered user uploads a profile image, node crashes.

Replication steps:

• Register as a new user
• You are taken to your profile
• Upload a profile pic
• Crash

Input style on registration page is out of date

Needs to be the lighter gray and inset

No hover effect on the submit button on the registration page