Files
freeCodeCamp/README.md

57 lines
2.4 KiB
Markdown
Raw Normal View History

2014-01-26 19:00:06 -05:00
![Alt](https://lh4.googleusercontent.com/-PVw-ZUM9vV8/UuWeH51os0I/AAAAAAAAD6M/0Ikg7viJftQ/w1286-h566-no/hackathon-starter-logo.jpg)
2013-12-29 18:22:44 -05:00
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.
2013-12-29 18:22:44 -05:00
2013-12-29 18:28:53 -05:00
![](https://lh6.googleusercontent.com/-NikjFtdyOq8/UsCv7URplAI/AAAAAAAADrE/a417u0cZU7Y/w1278-h958-no/Screenshot+2013-12-29+18.27.10.png)
2013-12-29 18:43:07 -05:00
Features
--------
- Local authentication using Email and Password
- OAuth2 authentication via Twitter, Facebook, Google or GitHub
2014-01-06 19:31:30 -05:00
- MVC Code Structure
2014-01-08 16:43:16 -05:00
- Bootstrap 3 + Flat UI + iOS7 Themes
2014-01-06 19:31:30 -05:00
- LESS stylesheets (auto-compiled)
2014-01-08 16:43:16 -05:00
- Contact Form (powered by Sendgrid)
- Account Management page
- 9 API Examples
2013-12-29 18:43:07 -05:00
2013-12-29 18:22:44 -05:00
Prerequisites
-------------
2013-12-29 19:11:23 -05:00
> - MongoDB
> - Node.js
> - **Xcode** (Mac OS X) or **Visual Studio** (Windows)
2013-12-29 18:22:44 -05:00
Quick Start
-----------
2014-01-11 23:22:26 -05:00
[Download the latest release](https://github.com/sahat/hackathon-starter/releases).
Then follow these commands to install third-party library dependencies and start the server.
2013-12-29 18:22:44 -05:00
```
2014-01-11 23:22:26 -05:00
cd hackathon-starter-1.0
2013-12-29 18:22:44 -05:00
npm install
node app.js
```
Recommended node.js libraries
----------------
- geoip-lite - get location name from IP address.
- [node-validator](https://github.com/chriso/node-validator) - input validation and sanitization.
Recommended client-side libraries
---------------------------------
- [Hover](https://github.com/IanLunn/Hover) - awesome css3 animations on mouse hover.
- [platform.js](https://github.com/bestiejs/platform.js) - get client's operating system name, version, and other useful information.
- [iCheck](https://github.com/fronteed/iCheck) - custom nice looking radio and check boxes.
Contributing
------------
2013-12-29 19:11:23 -05:00
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.