freeCodeCamp.org's open-source codebase and curriculum. Learn to code for free.

careers certification community curriculum d3 education freecodecamp hacktoberfest javascript learn-to-code math nodejs nonprofits programming react teachers

Go to file

Sahat Yalkabov 2179994e24 Merge remote-tracking branch 'origin/master' * origin/master: Update README.md		2014-01-11 22:53:56 -05:00
config	All 4 strategies will now create an email field (for local login) if the user is not logged in and it's the first time.	2014-01-07 16:04:28 -05:00
controllers	Refactoring	2014-01-07 18:15:14 -05:00
models	Updated schema	2014-01-07 16:33:48 -05:00
public	Replaced clusters in favor of mongoose connection error handler. Plus, Css updates.	2014-01-11 22:53:31 -05:00
views	Updated 404 page.	2014-01-08 00:41:56 -05:00
.gitignore	Added IntellIJ iml file to gitignore	2013-12-05 09:51:05 -05:00
Procfile	Updated Procfile	2014-01-07 13:40:24 -05:00
README.md	Update README.md	2014-01-08 16:43:16 -05:00
app.js	Replaced clusters in favor of mongoose connection error handler. Plus, Css updates.	2014-01-11 22:53:31 -05:00
package.json	Connect-mongo for mongodb sessions	2014-01-07 14:07:18 -05:00

README.md

Hackathon Starter

A kickstarter for Node.js web applications.

When I started this project, my primary focus was on simplicity and ease of use. Anyone who knows a little bit of JavaScript should be able to get started without too much pain. I tried to make it as generic and reusable as possible to cover most use cases of hackathon web apps, without being too specific.

Chances are, you will not need all 4 types of OAuth2 authentication methods, or all 9 API Browser examples. Sadly, there is no step-by-step wizzard to configure the boilerplate code just for your use case. So, use what you need, simply delete what you don't need.

Features

Local authentication using Email and Password
OAuth2 authentication via Twitter, Facebook, Google or GitHub
MVC Code Structure
Bootstrap 3 + Flat UI + iOS7 Themes
LESS stylesheets (auto-compiled)
Contact Form (powered by Sendgrid)
Account Management page
9 API Examples
Zero-downtime using Node.js Clusters

Prerequisites

MongoDB

Node.js

Xcode (Mac OS X) or Visual Studio (Windows)

Quick Start

git clone git://github.com/sahat/hackathon-starter
cd hackathon-starter
npm install
node app.js

Contributing

If something is unclear, confusing, or needs to be refactored, please let me know. Pull requests are always welcome, but due to the opinionated nature of this project, I cannot accept every pull request. Please open an issue before submitting a pull request.