Build Guide

[sizzlemctwizzle]

Building this thing is starting to get complex with the addition of S3. We should put together a step by step guide of how to build and run the site locally so that developers don't have to try and figure it out on their own.

[jerone]

And add a reference in the README.md

[sizzlemctwizzle]

Yeah, maybe.
Packages that MUST be installed:

npm install express toobusy mu2 mongoose connect-mongo formidable async aws-sdk passport passport-github

Then you need to install (and ruby too): https://github.com/jubos/fake-s3

[cletusc]

I just did something like this for another project I am working on. See my contributing guide for some ideas.

[jerone]

@cletusc That's perfect, only add fake-s3 for development and it's finished.

[sizzlemctwizzle]

Also change the bit about installing the package to forking, cloning your fork and then adding the main repo as remote upstream in git. Then mention about creating issues, branches for them, and submitting a pull request. Some of our contributors might be unfamiliar with git, so link to some guide (I actually wrote my own git crash course for another project that we could use; it's very short and to the point).

[Watilin]

I'm currently struggling with this point after I saw my fork didn't get automatically updated. Fortunately, Github's fork help explains it pretty well. In fact I was wondering what will happen to Dexmaster's fork – which is based on mine – once I get mine updated.

[cletusc]

FYI, I did have some notes about commits in the original style guide that you could probably adapt as well.

[sizzlemctwizzle]

Forks don't update automatically. His fork will remain in its current state until he updates it.