diff --git a/README.md b/README.md index 944320bb3ff..0c961f295e4 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,13 @@ When I started this project, my primary focus was on **simplicity** and **ease o 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. -![](https://lh6.googleusercontent.com/-NikjFtdyOq8/UsCv7URplAI/AAAAAAAADrE/a417u0cZU7Y/w1278-h958-no/Screenshot+2013-12-29+18.27.10.png) +

Flatly Bootstrap Theme

+ +![Alt](https://lh6.googleusercontent.com/-NikjFtdyOq8/UsCv7URplAI/AAAAAAAADrE/a417u0cZU7Y/w1278-h958-no/Screenshot+2013-12-29+18.27.10.png) + +

Default Theme

+ +![Alt](https://lh5.googleusercontent.com/-KmlaMLKGCqg/UuWt4MrXzeI/AAAAAAAAD6o/KUucObo33zU/w1170-h860-no/Screenshot+2014-01-26+19.52.03.png) Features -------- @@ -29,18 +35,47 @@ Prerequisites Quick Start ----------- +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. + [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. + ``` cd hackathon-starter-1.0 npm install node app.js ``` -Recommended node.js libraries ----------------- +**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 +------------------ + + + - 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. + +Recommended Node.js Libraries +----------------------------- +- nodemon - automatically restart node.js server on code change. - geoip-lite - get location name from IP address. - [node-validator](https://github.com/chriso/node-validator) - input validation and sanitization.