2014-01-27 00:00:06 +00:00
2013-12-29 23:22:44 +00:00
Hackathon Starter
=================
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.
2013-12-29 23:22:44 +00:00
2014-01-27 00:55:57 +00:00
< h3 align = "center" > Flatly Bootstrap Theme< / h3 >
< h3 align = "center" > Default Theme< / h3 >
2013-12-29 23:28:53 +00:00
2013-12-29 23:43:07 +00:00
Features
--------
- Local authentication using Email and Password
- OAuth2 authentication via Twitter, Facebook, Google or GitHub
2014-01-07 00:31:30 +00:00
- MVC Code Structure
2014-01-08 21:43:16 +00:00
- Bootstrap 3 + Flat UI + iOS7 Themes
2014-01-07 00:31:30 +00:00
- LESS stylesheets (auto-compiled)
2014-01-08 21:43:16 +00:00
- Contact Form (powered by Sendgrid)
- Account Management page
- 9 API Examples
2013-12-29 23:43:07 +00:00
2013-12-29 23:22:44 +00:00
Prerequisites
-------------
2013-12-30 00:11:23 +00:00
> - MongoDB
> - Node.js
> - **Xcode** (Mac OS X) or **Visual Studio** (Windows)
2013-12-29 23:22:44 +00:00
Quick Start
-----------
2014-01-27 00:55:57 +00:00
Git clone: `git clone --depth=1 git@github.com:sahat/hackathon-starter.git`
**Note**: The depth=1 specifies to clone only the latest revision, instead of cloning the entire repo with full history.
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.
2014-01-27 00:55:57 +00:00
2013-12-29 23:22:44 +00:00
```
2014-01-12 04:22:26 +00:00
cd hackathon-starter-1.0
2013-12-29 23:22:44 +00:00
npm install
node app.js
```
2014-01-27 00:55:57 +00:00
**Note**: I highly recommend installing nodemon `sudo npm install -g nodemon` .
It will monitor for any changes in your node.js
application and automatically restart the server. Once installed, instead of `node app.js` use `nodemon app.js` .
Next, if you want to use any of the APIs or OAuth2 authentication methods, you will need to obtain
appropriate ClientID/ClientSecret, API Key, or Username/Password.
Obtaining API Keys
------------------
< img src = "http://images.google.com/intl/en_ALL/images/srpr/logo6w.png" width = "200" >
- Go to [https://cloud.google.com/console/project ](https://cloud.google.com/console/project )
- Click **CREATE PROJECT** button
- Enter *Project Name* , then click **CREATE**
- Then select *APIs & auth* from the sidebar and click on *Credentials* tab
- Click **CREATE NEW CLIENT ID** button
- **Application Type**: Web Application
- **Authorized Javascript origins**: http://localhost:3000
- **Authorized redirect URI**: http://localhost:3000/auth/google/callback
- Copy and paste *Client ID* and *Client secret* keys into `config/secrets.js`
> **Note**: When you ready to deploy to production don't forget to add
> your new url to Authorized Javascript origins and Authorized redirect URI,
> e.g. `http://my-awesome-app.herokuapp.com` and `http://my-awesome-app.herokuapp.com/auth/google/callback` respectively.
2014-01-15 08:12:47 +00:00
2014-01-27 00:55:57 +00:00
Recommended Node.js Libraries
-----------------------------
- nodemon - automatically restart node.js server on code change.
2014-01-15 08:12:47 +00:00
- 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.
2013-12-30 00:08:27 +00:00
Contributing
------------
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.
