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 a72900a5e1 Changed to doctype html		2014-01-03 04:47:31 -05:00
config	Cleaned up code + simplified	2013-12-20 14:12:29 -05:00
controllers	Cleaned up code + simplified	2013-12-20 14:12:29 -05:00
models	Removed DB validations	2014-01-01 02:35:37 -05:00
public	Removed unusued code and images	2013-12-19 13:16:32 -05:00
views	Changed to doctype html	2014-01-03 04:47:31 -05:00
.gitignore	Added IntellIJ iml file to gitignore	2013-12-05 09:51:05 -05:00
Procfile	converted all auth functions to use mongoose	2013-11-14 00:15:52 -05:00
README.md	Update README.md	2013-12-29 19:11:23 -05:00
app.js	Cleaned up code + simplified	2013-12-20 14:12:29 -05:00
package.json	Twitter API library	2013-12-10 01:53:28 -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 Structure
Bootstrap 3 + Flat UI
Contact Form
Account Management
API Examples

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.