greatbody
/
freeCodeCamp
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
freeCodeCamp.org's open-source codebase and curriculum. Learn to code for free.
418 Commits
3 Branches
0 Tags
959 MiB
TypeScript 66.2%
JavaScript 28.8%
CSS 4.5%
Dockerfile 0.3%
Shell 0.1%
 
 
 
 
 
Go to file
Sahat Yalkabov 010a1d8bad Update README.md 
Recommended libraries section
 		2014-01-15 03:12:47 -05:00
config Updated error messages 2014-01-12 15:31:17 -05:00
controllers Updated jsdoc comments 2014-01-13 04:34:54 -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 Code cleanup, updated jsdoc comments, added missing "next" error middleware to api.js controllers. 2014-01-13 04:24:31 -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-15 03:12:47 -05:00
app.js Code cleanup, updated jsdoc comments, added missing "next" error middleware to api.js controllers. 2014-01-13 04:24: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

Prerequisites

  • MongoDB
  • Node.js
  • Xcode (Mac OS X) or Visual Studio (Windows)

Quick Start

Download the latest release.

Then follow these commands to install third-party library dependencies and start the server.

cd hackathon-starter-1.0
npm install
node app.js

Recommended node.js libraries

  • geoip-lite - get location name from IP address.
  • node-validator - input validation and sanitization.

Recommended client-side libraries

  • Hover - awesome css3 animations on mouse hover.
  • platform.js - get client's operating system name, version, and other useful information.
  • iCheck - custom nice looking radio and check boxes.

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.