greatbody
/
freeCodeCamp
mirror of https://github.com/freeCodeCamp/freeCodeCamp.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
freeCodeCamp/README.md

56 lines
2.3 KiB
Markdown
Raw Normal View History

Update README.md
2013-12-29 23:22:44 +00:00
Hackathon Starter
=================
Brief description and contributing section
2013-12-30 00:08:27 +00:00
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.
Update README.md
2013-12-29 23:22:44 +00:00
Added screenshot
2013-12-29 23:28:53 +00:00
![](https://lh6.googleusercontent.com/-NikjFtdyOq8/UsCv7URplAI/AAAAAAAADrE/a417u0cZU7Y/w1278-h958-no/Screenshot+2013-12-29+18.27.10.png)
Included Features
2013-12-29 23:43:07 +00:00
Features
--------
- Local authentication using Email and Password
- OAuth2 authentication via Twitter, Facebook, Google or GitHub
Comments. Updated readme.
2014-01-07 00:31:30 +00:00
- MVC Code Structure
Update README.md
2014-01-08 21:43:16 +00:00
- Bootstrap 3 + Flat UI + iOS7 Themes
Comments. Updated readme.
2014-01-07 00:31:30 +00:00
- LESS stylesheets (auto-compiled)
Update README.md
2014-01-08 21:43:16 +00:00
- Contact Form (powered by Sendgrid)
- Account Management page
- 9 API Examples
Included Features
2013-12-29 23:43:07 +00:00
Update README.md
2013-12-29 23:22:44 +00:00
Prerequisites
-------------
Update README.md
2013-12-30 00:11:23 +00:00
> - MongoDB
> - Node.js
> - **Xcode** (Mac OS X) or **Visual Studio** (Windows)
Update README.md
2013-12-29 23:22:44 +00:00
Quick Start
-----------
Update README.md
2014-01-12 04:22:26 +00: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.
Update README.md
2013-12-29 23:22:44 +00:00
```
Update README.md
2014-01-12 04:22:26 +00:00
cd hackathon-starter-1.0
Update README.md
2013-12-29 23:22:44 +00:00
npm install
node app.js
```
Update README.md Recommended libraries section
2014-01-15 08:12:47 +00:00
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.
Brief description and contributing section
2013-12-30 00:08:27 +00:00
Contributing
------------
Update README.md
2013-12-30 00:11:23 +00: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.