PageRenderTime 67ms CodeModel.GetById 21ms RepoModel.GetById 1ms app.codeStats 0ms

/README.md

https://gitlab.com/fuzzynemesis/hackathon-starter
Markdown | 1414 lines | 1162 code | 252 blank | 0 comment | 0 complexity | 6eed7e5d8087597f028986cb269632e9 MD5 | raw file
    

  1. ![Alt](https://lh4.googleusercontent.com/-PVw-ZUM9vV8/UuWeH51os0I/AAAAAAAAD6M/0Ikg7viJftQ/w1286-h566-no/hackathon-starter-logo.jpg)
    2. 

  2. Hackathon Starter [![Dependency Status](https://david-dm.org/sahat/hackathon-starter/status.svg?style=flat)](https://david-dm.org/sahat/hackathon-starter) [![Build Status](http://img.shields.io/travis/sahat/hackathon-starter.svg?style=flat)](https://travis-ci.org/sahat/hackathon-starter) [![Analytics](https://ga-beacon.appspot.com/UA-47447818-2/hackathon-starter?pixel)](https://github.com/igrigorik/ga-beacon)
    3. 

  3. =======================
    4. 

  4. 

  5. [![Join the chat at https://gitter.im/sahat/hackathon-starter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sahat/hackathon-starter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Thinkful Pair on Node](https://tf-assets-staging.s3.amazonaws.com/badges/thinkful_repo_badge.svg)](http://start.thinkful.com/node/)
    6. 

  6. 

  7. **Live Demo**: http://hackathonstarter.herokuapp.com
    8. 

  8. 

  9. Jump to [What's new in 3.0.3?](#changelog)
    10. 

    11. 

  11. A boilerplate for **Node.js** web applications.
    12. 

  12. 

  13. If you have attended any hackathons in the past, then you know how much time it takes to
    14. 

  14. get a project started: decide on what to build, pick a programming language, pick a web framework,
    15. 

  15. pick a CSS framework. A while later, you might have an initial project up on GitHub and only then
    16. 

  16. can other team members start contributing. Or how about doing something as simple as *Sign in with Facebook*
    17. 

  17. authentication? You can spend hours on it if you are not familiar with how OAuth 2.0 works.
    18. 

  18. 

  19. When I started this project, my primary focus was on **simplicity** and **ease of use**.
    20. 

  20. I also tried to make it as **generic** and **reusable** as possible to cover most use cases of hackathon web apps,
    21. 

  21. without being too specific. In the worst case you can use this as a learning guide for your projects,
    22. 

  22. if for example you are only interested in **Sign in with Google** authentication and nothing else.
    23. 

  23. 

  24. Chances are you do not need all authentication methods or API examples. As of **Hackathon Starter 2.1**
    25. 

  25. it is possible to selectively check which authentication methods you need by running `node setup.js`.
    26. 

  26. 

  27. <h4 align="center">Modern Theme</h4>
    28. 

  28. 

  29. ![](https://lh6.googleusercontent.com/-KQTmCFNK6MM/U7OZpznjDuI/AAAAAAAAERc/h3jR27Uy1lE/w1366-h1006-no/Screenshot+2014-07-02+01.32.22.png)
    30. 

  30. 

  31. <h4 align="center">Flatly Bootstrap Theme</h4>
    32. 

  32. 

  33. ![](https://lh5.googleusercontent.com/-oJ-7bSYisRY/U1a-WhK_LoI/AAAAAAAAECM/a04fVYgefzw/w1474-h1098-no/Screen+Shot+2014-04-22+at+3.08.33+PM.png)
    34. 

  34. 

  35. <h4 align="center">API Examples</h4>
    36. 

  36. 

  37. ![](https://lh5.googleusercontent.com/-BJD2wK8CvC8/VLodBsyL-NI/AAAAAAAAEx0/SafE6o_qq_I/w1818-h1186-no/Screenshot%2B2015-01-17%2B00.25.49.png)
    38. 

  38. 

  39. <h4 align="center">Hackathon Starter Generator</h4>
    40. 

  40. 

  41. ![](https://lh4.googleusercontent.com/-ncBLUzq6czE/U3KkYE0UXsI/AAAAAAAAEEM/YsZeIqOlZg8/w1288-h874-no/Screenshot+2014-05-13+19.01.15.png)
    42. 

  42. 

  43. Table of Contents
    44. 

  44. -----------------
    45. 

  45. 

  46. - [Features](#features)
    47. 

  47. - [Prerequisites](#prerequisites)
    48. 

  48. - [Getting Started](#getting-started)
    49. 

  49. - [Generator](#generator)
    50. 

  50. - [Obtaining API Keys](#obtaining-api-keys)
    51. 

  51. - [Project Structure](#project-structure)
    52. 

  52. - [List of Packages](#list-of-packages)
    53. 

  53. - [Useful Tools and Resources](#useful-tools-and-resources)
    54. 

  54. - [Recommended Design Resources](#recommended-design-resources)
    55. 

  55. - [Recommended Node.js Libraries](#recommended-nodejs-libraries)
    56. 

  56. - [Recommended Client-side Libraries](#recommended-client-side-libraries)
    57. 

  57. - [Pro Tips](#pro-tips)
    58. 

  58. - [FAQ](#faq)
    59. 

  59. - [How It Works](#how-it-works-mini-guides)
    60. 

  60. - [Mongoose Cheatsheet](#mongoose-cheatsheet)
    61. 

  61. - [Deployment](#deployment)
    62. 

  62. - [Changelog](#changelog)
    63. 

  63. - [Contributing](#contributing)
    64. 

  64. - [License](#license)
    65. 

  65. 

  66. Features
    67. 

  67. --------
    68. 

  68. 

  69. - **Local Authentication** using Email and Password
    70. 

  70. - **OAuth 1.0a Authentication** via Twitter
    71. 

  71. - **OAuth 2.0 Authentication** via Facebook, Google, GitHub, LinkedIn, Instagram
    72. 

  72. - Flash notifications
    73. 

  73. - MVC Project Structure
    74. 

  74. - Node.js clusters support
    75. 

  75. - Rails 3.1-style asset pipeline by connect-assets (See FAQ)
    76. 

  76. - LESS stylesheets (auto-compiled without any Gulp/Grunt hassle)
    77. 

  77. - Bootstrap 3 + Flat UI + iOS7
    78. 

  78. - Contact Form (powered by Mailgun, Sendgrid or Mandrill)
    79. 

  79. - **Account Management**
    80. 

  80.  - Gravatar
    81. 

  81.  - Profile Details
    82. 

  82.  - Change Password
    83. 

  83.  - Forgot Password
    84. 

  84.  - Reset Password
    85. 

  85.  - Link multiple OAuth strategies to one account
    86. 

  86.  - Delete Account
    87. 

  87. - CSRF protection
    88. 

  88. - **API Examples**: Facebook, Foursquare, Last.fm, Tumblr, Twitter, Stripe, LinkedIn and more.
    89. 

  89. 

  90. Prerequisites
    91. 

  91. -------------
    92. 

  92. 

  93. - [MongoDB](http://www.mongodb.org/downloads)
    94. 

  94. - [Node.js](http://nodejs.org)
    95. 

  95. - Command Line Tools
    96. 

  96.  - <img src="http://deluge-torrent.org/images/apple-logo.gif" height="17">&nbsp;**Mac OS X**: [Xcode](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) (or **OS X 10.9 Mavericks**: `xcode-select --install`)
    97. 

  97.  - <img src="http://dc942d419843af05523b-ff74ae13537a01be6cfec5927837dcfe.r14.cf1.rackcdn.com/wp-content/uploads/windows-8-50x50.jpg" height="17">&nbsp;**Windows**: [Visual Studio](http://www.visualstudio.com/downloads/download-visual-studio-vs#d-express-windows-8)
    98. 

  98.  - <img src="https://lh5.googleusercontent.com/-2YS1ceHWyys/AAAAAAAAAAI/AAAAAAAAAAc/0LCb_tsTvmU/s46-c-k/photo.jpg" height="17">&nbsp;**Ubuntu**: `sudo apt-get install build-essential`
    99. 

  99.  - <img src="http://i1-news.softpedia-static.com/images/extra/LINUX/small/slw218news1.png" height="17">&nbsp;**Fedora**: `sudo dnf groupinstall "Development Tools"`
    100. 

  100.  - <img src="https://en.opensuse.org/images/b/be/Logo-geeko_head.png" height="17">&nbsp;**OpenSUSE**: `sudo zypper install --type pattern devel_basis`
    101. 

  101. 

  102. **Note:** If you are new to Node or Express, I recommend to watch
    103. 

  103. [Node.js and Express 101](http://www.youtube.com/watch?v=BN0JlMZCtNU)
    104. 

  104. screencast by Alex Ford that teaches Node and Express from scratch. Alternatively,
    105. 

  105. here is another great tutorial for complete beginners - [Getting Started With Node.js, Express, MongoDB](http://cwbuecheler.com/web/tutorials/2013/node-express-mongo/).
    106. 

  106. 

  107. Getting Started
    108. 

  108. ---------------
    109. 

  109. 

  110. The easiest way to get started is to clone the repository:
    111. 

  111. 

  112. ```bash
    113. 

  113. # Get the latest snapshot
    114. 

  114. $ git clone https://github.com/sahat/hackathon-starter.git myproject
    115. 

  115. $ cd myproject
    116. 

  116. $ git remote rm origin
    117. 

    118. 

  118. # Install NPM dependencies
    119. 

  119. $ npm install
    120. 

    121. 

  121. $ node app.js
    122. 

  122. ```
    123. 

  123. 

  124. **Note:** I highly recommend installing [Nodemon](https://github.com/remy/nodemon).
    125. 

  125. It watches for any changes in your  node.js app and automatically restarts the
    126. 

  126. server. Once installed, instead of `node app.js` use `nodemon app.js`. It will
    127. 

  127. save you a lot of time in the long run, because you won't need to manually
    128. 

  128. restart the server each time you make a small change in code. To install, run
    129. 

  129. `sudo npm install -g nodemon`.
    130. 

  130. 

  131. Generator
    132. 

  132. ---------
    133. 

  133. 

  134. Hackathon Starter Generator is tighly coupled to the project code. As soon as you
    135. 

  135. start changing and moving things around, it will probably no longer work as
    136. 

  136. expected. That is why it's best to use when you first download the project.
    137. 

    138. 

  138. Currently it supports switching between SendGrid, Mailgun and Mandrill email
    139. 

  139. services and adding a Node.js cluster support.
    140. 

  140. 

  141. To get started, run: `node setup.js`.
    142. 

  142. 

  143. **Note:** Generator has a "destructive" behavior, it will physically
    144. 

  144. modify your code. *There is no undo action.* To be on a safe side, always commit
    145. 

  145. your code to Git, so you could go back and revert the changes.
    146. 

  146. 

  147. Obtaining API Keys
    148. 

  148. ------------------
    149. 

  149. 

  150. To use any of the included APIs or OAuth authentication methods, you will need
    151. 

  151. to obtain appropriate credentials: Client ID, Client Secret, API Key, or
    152. 

  152. Username & Password. You will need to go through each provider to generate new
    153. 

  153. credentials.
    154. 

  154. 

  155. **Hackathon Starter 2.0 Update:** I have included dummy keys and passwords for
    156. 

  156. all API examples to get you up and running even faster. But don't forget to update
    157. 

  157. them with *your credentials* when you are ready to deploy an app.
    158. 

  158. 

  159. <img src="http://images.google.com/intl/en_ALL/images/srpr/logo6w.png" width="200">
    160. 

  160. - Visit [Google Cloud Console](https://cloud.google.com/console/project)
    161. 

  161. - Click on the **Create Project** button
    162. 

  162. - Enter *Project Name*, then click on **Create** button
    163. 

  163. - Then click on *APIs & auth* in the sidebar and select *API* tab
    164. 

  164. - Click on **Google+ API** under *Social APIs*, then click **Enable API**
    165. 

  165. - Next, under *APIs & auth* in the sidebar click on *Credentials* tab
    166. 

  166. - Click on **Create new Client ID** button
    167. 

  167. - Select *Web Application* and click on **Configure Consent Screen**
    168. 

  168. - Fill out the required fields then click on **Save**
    169. 

  169. - In the *Create Client ID* modal dialog:
    170. 

  170.  - **Application Type**: Web Application
    171. 

  171.  - **Authorized Javascript origins**: http://localhost:3000
    172. 

  172.  - **Authorized redirect URI**: http://localhost:3000/auth/google/callback
    173. 

  173. - Click on **Create Client ID** button
    174. 

  174. - Copy and paste *Client ID* and *Client secret* keys into `config/secrets.js`
    175. 

  175. 

  176. **Note:** When you ready to deploy to production don't forget to
    177. 

  177. add your new url to *Authorized Javascript origins* and *Authorized redirect URI*,
    178. 

  178. e.g. `http://my-awesome-app.herokuapp.com` and
    179. 

  179. `http://my-awesome-app.herokuapp.com/auth/google/callback` respectively.
    180. 

  180. The same goes for other providers.
    181. 

  181. 

  182. <hr>
    183. 

  183. 

  184. <img src="http://www.doit.ba/img/facebook.jpg" width="200">
    185. 

  185. - Visit [Facebook Developers](https://developers.facebook.com/)
    186. 

  186. - Click **Apps > Create a New App** in the navigation bar
    187. 

  187. - Enter *Display Name*, then choose a category, then click **Create app**
    188. 

  188. - Copy and paste *App ID* and *App Secret* keys into `config/secrets.js`
    189. 

  189.  - *App ID* is **clientID**, *App Secret* is **clientSecret**
    190. 

  190. - Click on *Settings* on the sidebar, then click **+ Add Platform**
    191. 

  191. - Select **Website**
    192. 

  192. - Enter `http://localhost:3000` for *Site URL*
    193. 

  193. 

  194. **Note:** After a successful sign in with Facebook, a user will be redirected back to home page with appended hash `#_=_` in the URL. It is *not* a bug. See this [Stack Overflow](https://stackoverflow.com/questions/7131909/facebook-callback-appends-to-return-url) discussion for ways to handle it.
    195. 

  195. 

  196. <hr>
    197. 

  197. 

  198. <img src="https://github.global.ssl.fastly.net/images/modules/logos_page/GitHub-Logo.png" width="200">
    199. 

  199. - Go to [Account Settings](https://github.com/settings/profile)
    200. 

  200. - Select **Applications** from the sidebar
    201. 

  201. - Then inside **Developer applications** click on **Register new application**
    202. 

  202. - Enter *Application Name* and *Homepage URL*
    203. 

  203. - For *Authorization Callback URL*: http://localhost:3000/auth/github/callback
    204. 

  204. - Click **Register application**
    205. 

  205. - Now copy and paste *Client ID* and *Client Secret* keys into `config/secrets.js`
    206. 

  206. 

  207. <hr>
    208. 

  208. 

  209. <img src="https://g.twimg.com/Twitter_logo_blue.png" width="90">
    210. 

  210. - Sign in at [https://apps.twitter.com/](https://apps.twitter.com/)
    211. 

  211. - Click **Create a new application**
    212. 

  212. - Enter your application name, website and description
    213. 

  213. - For **Callback URL**: http://127.0.0.1:3000/auth/twitter/callback
    214. 

  214. - Go to **Settings** tab
    215. 

  215. - Under *Application Type* select **Read and Write** access
    216. 

  216. - Check the box **Allow this application to be used to Sign in with Twitter**
    217. 

  217. - Click **Update this Twitter's applications settings**
    218. 

  218. - Copy and paste *Consumer Key* and *Consumer Secret* keys into `config/secrets.js`
    219. 

  219. 

  220. <hr>
    221. 

  221. 

  222. <img src="http://www.danpontefract.com/wp-content/uploads/2014/02/logo-linkedin.png" width="200">
    223. 

  223. - Sign in at [LinkedIn Developer Network](http://developer.linkedin.com/)
    224. 

  224. - From the account name dropdown menu select **API Keys**
    225. 

  225.  - *It may ask you to sign in once again*
    226. 

  226. - Click **+ Add New Application** button
    227. 

  227. - Fill out all the *required* fields
    228. 

  228.  - **OAuth 2.0 Redirect URLs**: http://localhost:3000/auth/linkedin/callback
    229. 

  229.  - **JavaScript API Domains**: http://localhost:3000
    230. 

  230. - For **Default Application Permissions** make sure at least the following is checked:
    231. 

  231.  - `r_basicprofile`
    232. 

  232. - Finish by clicking **Add Application** button
    233. 

  233. - Copy and paste *API Key* and *Secret Key* keys into `config/secrets.js`
    234. 

  234.  - *API Key* is your **clientID**
    235. 

  235.  - *Secret Key* is your **clientSecret**
    236. 

  236. 

  237. <hr>
    238. 

  238. 

  239. <img src="https://s3.amazonaws.com/venmo/venmo_logo_blue.png" width="200">
    240. 

  240. - Visit the **Account** section of your Venmo profile after logging in
    241. 

  241. - Click on the **Developers** tab
    242. 

  242. - Then click on the [new](https://venmo.com/account/app/new) link next to **Your Applications (0)**
    243. 

  243. - Fill in the required fields: *App Name* and *What Will The App Be Used For?*
    244. 

  244. - For **Web Redirect URL** enter: http://localhost:3000/auth/venmo/callback
    245. 

  245. - Hit **Create** button
    246. 

  246. - Back on the **Developers** tab click on **view** link next to **Your Applications (1) new**
    247. 

  247. - Copy and paste **ID** and **Secret** keys into `config/secrets.js`
    248. 

  248. 

  249. <hr>
    250. 

  250. 

  251. <img src="https://stripe.com/img/about/logos/logos/black@2x.png" width="200">
    252. 

  252. - [Sign up](http://stripe.com) or log into your [dashboard](https://manage.stripe.com)
    253. 

  253. - Click on your profile and click on Account Settings
    254. 

  254. - Then click on [API Keys](https://manage.stripe.com/account/apikeys)
    255. 

  255. - Copy the **Secret Key**. and add this into `config/secrets.js`
    256. 

  256. <hr>
    257. 

  257. 

  258. <img src="https://www.paypalobjects.com/webstatic/developer/logo_paypal-developer_beta.png" width="200">
    259. 

  259. - Visit [PayPal Developer](https://developer.paypal.com/)
    260. 

  260. - Log in to your PayPal account
    261. 

  261. - Click **Applications > Create App** in the navigation bar
    262. 

  262. - Enter *Application Name*, then click **Create app**
    263. 

  263. - Copy and paste *Client ID* and *Secret* keys into `config/secrets.js`
    264. 

  264. - *App ID* is **client_id**, *App Secret* is **client_secret**
    265. 

  265. - Change **host** to api.paypal.com if you want to test against production and use the live credentials
    266. 

  266. 

  267. <hr>
    268. 

  268. 

  269. <img src="https://playfoursquare.s3.amazonaws.com/press/2014/foursquare-logomark.png" width="200">
    270. 

  270. - Go to [foursquare for Developers](https://developer.foursquare.com/)
    271. 

  271. - Click on **My Apps** in the top menu
    272. 

  272. - Click the **Create A New App** button
    273. 

  273. - Enter *App Name*, *Welcome page url*,
    274. 

  274. - For **Redirect URI**: http://localhost:3000/auth/foursquare/callback
    275. 

  275. - Click **Save Changes**
    276. 

  276. - Copy and paste *Client ID* and *Client Secret* keys into `config/secrets.js`
    277. 

  277. 

  278. <hr>
    279. 

  279. 

  280. <img src="http://img4.wikia.nocookie.net/__cb20130520163346/logopedia/images/8/8d/Tumblr_logo_by_x_1337_x-d5ikwpp.png" width="200">
    281. 

  281. - Go to http://www.tumblr.com/oauth/apps
    282. 

  282. - Once signed in, click **+Register application**
    283. 

  283. - Fill in all the details
    284. 

  284. - For **Default Callback URL**: http://localhost:3000/auth/tumblr/callback
    285. 

  285. - Click **✔Register**
    286. 

  286. - Copy and paste *OAuth consumer key* and *OAuth consumer secret* keys into `config/secrets.js`
    287. 

  287. 

  288. <hr>
    289. 

  289. 

  290. <img src="http://www.technologytell.com/gaming/files/2012/01/steam_logo.jpg" width="200">
    291. 

  291. - Go to http://steamcommunity.com/dev/apikey
    292. 

  292. - Sign in with your existing Steam account
    293. 

  293. - Enter your *Domain Name*, then and click **Register**
    294. 

  294. - Copy and paste *Key* into `config/secrets.js`
    295. 

  295. 

  296. <hr>
    297. 

  297. 

  298. <img src="http://iandouglas.com/presentations/pyconca2012/logos/sendgrid_logo.png" width="200">
    299. 

  299. - Go to https://sendgrid.com/user/signup
    300. 

  300. - Sign up and **confirm** your account via the *activation email*
    301. 

  301. - Then enter your SendGrid *Username* and *Password* into `config/secrets.js`
    302. 

  302. 

  303. <hr>
    304. 

  304. 

  305. <img src="https://raw.github.com/mailgun/media/master/Mailgun_Primary.png" width="200">
    306. 

  306. - Go to http://www.mailgun.com
    307. 

  307. - Sign up and add your *Domain Name*
    308. 

  308. - From the domain overview, copy and paste the default SMTP *Login* and *Password* into `config/secrets.js`
    309. 

  309. 

  310. <hr>
    311. 

  311. 

  312. <img src="http://cdn.appstorm.net/web.appstorm.net/web/files/2013/12/mandrill-logo.png" width="100">
    313. 

  313. - Go to http://mandrill.com
    314. 

  314. - Sign up and add your *Domain Name*
    315. 

  315. - From the dashboard, click on *Get SMTP credentials*
    316. 

  316. - Copy and paste the default SMTP *Login* and *Password* into `config/secrets.js`
    317. 

  317. 

  318. <hr>
    319. 

  319. 

  320. <img src="https://www.bitgo.com/img/new_bitgo/logo_footer.png" width="200">
    321. 

  321. - Go to https://test.bitgo.com/
    322. 

  322. - Sign up for an account.
    323. 

  323. - Once logged into the dashboard, go to the top right selector and click 'account settings'
    324. 

  324. - Under the developers tab, create your access token and copy and paste it into `config/secrets.js`
    325. 

  325. 

  326. 

  327. Project Structure
    328. 

  328. -----------------
    329. 

  329. 

  330. | Name                               | Description                                                  |
    331. 

  331. | ---------------------------------- | ------------------------------------------------------------ |
    332. 

  332. | **config**/passport.js             | Passport Local and OAuth strategies, plus login middleware.  |
    333. 

  333. | **config**/secrets.js              | Your API keys, tokens, passwords and database URL.           |
    334. 

  334. | **controllers**/api.js             | Controller for /api route and all api examples.              |
    335. 

  335. | **controllers**/contact.js         | Controller for contact form.                                 |
    336. 

  336. | **controllers**/home.js            | Controller for home page (index).                            |
    337. 

  337. | **controllers**/user.js            | Controller for user account management.                      |
    338. 

  338. | **models**/User.js                 | Mongoose schema and model for User.                          |
    339. 

  339. | **public**/                        | Static assets (fonts, css, js, img).                         |
    340. 

  340. | **public**/**js**/application.js   | Specify client-side JavaScript dependencies.                 |
    341. 

  341. | **public**/**js**/main.js          | Place your client-side JavaScript here.                      |
    342. 

  342. | **public**/**css**/main.less       | Main stylesheet for your app.                                |
    343. 

  343. | **public/css/themes**/default.less | Some Bootstrap overrides to make it look prettier.           |
    344. 

  344. | **views/account**/                 | Templates for *login, password reset, signup, profile*.      |
    345. 

  345. | **views/api**/                     | Templates for API Examples.                                  |
    346. 

  346. | **views/partials**/flash.jade      | Error, info and success flash notifications.                 |
    347. 

  347. | **views/partials**/header.jade     | Navbar partial template.                                     |
    348. 

  348. | **views/partials**/footer.jade     | Footer partial template.                                     |
    349. 

  349. | **views**/layout.jade              | Base template.                                               |
    350. 

  350. | **views**/home.jade                | Home page template.                                          |
    351. 

  351. | app.js                             | Main application file.                                       |
    352. 

  352. | setup.js                           | Tool for removing authentication providers and other things. |
    353. 

  353. 

  354. **Note:** There is no preference how you name or structure your views.
    355. 

  355. You could place all your templates in a top-level `views` directory without
    356. 

  356. having a nested folder structure, if that makes things easier for you.
    357. 

  357. Just don't forget to update `extends ../layout`  and corresponding
    358. 

  358. `res.render()` paths in controllers.
    359. 

  359. 

  360. List of Packages
    361. 

  361. ----------------
    362. 

  362. 

  363. | Package                         | Description                                                           |
    364. 

  364. | ------------------------------- | --------------------------------------------------------------------- |
    365. 

  365. | async                           | Utility library that provides asynchronous control flow.              |
    366. 

  366. | bcrypt-nodejs                   | Library for hashing and salting user passwords.                       |
    367. 

  367. | bitgo                           | Multi-sig Bitcoin wallet API.  |
    368. 

  368. | cheerio                         | Scrape web pages using jQuery-style syntax.                           |
    369. 

  369. | clockwork                       | Clockwork SMS API library.                                            |
    370. 

  370. | connect-assets                  | Compiles LESS stylesheets, concatenates & minifies JavaScript.        |
    371. 

  371. | connect-mongo                   | MongoDB session store for Express.                                    |
    372. 

  372. | csso                            | Dependency for connect-assets library to minify CSS.                  |
    373. 

  373. | express                         | Node.js web framework.                                                |
    374. 

  374. | body-parser                     | Express 4 middleware.                                               |
    375. 

  375. | cookie-parser                   | Express 4 middleware.                                               |
    376. 

  376. | express-session                 | Express 4 middleware.                                               |
    377. 

  377. | morgan                          | Express 4 middleware.                                               |
    378. 

  378. | multer                          | Express 4 middleware.                                               |
    379. 

  379. | compression                     | Express 4 middleware.                                               |
    380. 

  380. | errorhandler                    | Express 4 middleware.                                               |
    381. 

  381. | method-override                 | Express 4 middleware.                                               |
    382. 

  382. | serve-favicon                   | Express 4 middleware offering favicon serving and caching.          |
    383. 

  383. | express-flash                   | Provides flash messages for Express.                                  |
    384. 

  384. | express-validator               | Easy form validation for Express.                                     |
    385. 

  385. | fbgraph                         | Facebook Graph API library.                                           |
    386. 

  386. | github-api                      | GitHub API library.                                                   |
    387. 

  387. | jade                            | Template engine for Express.                                          |
    388. 

  388. | lastfm                          | Last.fm API library.                                                  |
    389. 

  389. | instagram-node                  | Instagram API library.                                                |
    390. 

  390. | less                            | LESS compiler. Used implicitly by connect-assets.                     |
    391. 

  391. | lob                             | Lob API library                                                       |
    392. 

  392. | lusca                           | CSRF middleware.                                                      |
    393. 

  393. | mongoose                        | MongoDB ODM.                                                          |
    394. 

  394. | node-foursquare                 | Foursquare API library.                                               |
    395. 

  395. | node-linkedin                   | LinkedIn API library.                                                 |
    396. 

  396. | nodemailer                      | Node.js library for sending emails.                                   |
    397. 

  397. | passport                        | Simple and elegant authentication library for node.js                 |
    398. 

  398. | passport-facebook               | Sign-in with Facebook plugin.                                         |
    399. 

  399. | passport-github                 | Sign-in with GitHub plugin.                                           |
    400. 

  400. | passport-google-oauth           | Sign-in with Google plugin.                                           |
    401. 

  401. | passport-twitter                | Sign-in with Twitter plugin.                                          |
    402. 

  402. | passport-instagram              | Sign-in with Instagram plugin.                                        |
    403. 

  403. | passport-local                  | Sign-in with Username and Password plugin.                            |
    404. 

  404. | passport-linkedin-oauth2        | Sign-in with LinkedIn plugin.                                         |
    405. 

  405. | passport-oauth                  | Allows you to set up your own OAuth 1.0a and OAuth 2.0 strategies.    |
    406. 

  406. | paypal-rest-sdk                 | PayPal APIs library.                                                  |
    407. 

  407. | request                         | Simplified HTTP request library.                                      |
    408. 

  408. | stripe                          | Offical Stripe API library.                                           |
    409. 

  409. | tumblr.js                       | Tumblr API library.                                                   |
    410. 

  410. | twilio                          | Twilio API library.                                                   |
    411. 

  411. | twit                            | Twitter API library.                                                  |
    412. 

  412. | lodash                          | Handy JavaScript utlities library.                                    |
    413. 

  413. | uglify-js                       | Dependency for connect-assets library to minify JS.                   |
    414. 

  414. | validator                       | Used in conjunction with express-validator in **controllers/api.js**. |
    415. 

  415. | mocha                           | Test framework.                                                       |
    416. 

  416. | chai                            | BDD/TDD assertion library.                                            |
    417. 

  417. | supertest                       | HTTP assertion library.                                               |
    418. 

  418. | multiline                       | Multi-line strings for the generator.                                 |
    419. 

  419. | blessed                         | Interactive command line interface for the generator.                 |
    420. 

  420. | yui                             | Used by the Yahoo API example.                                        |
    421. 

  421. 

  422. Useful Tools and Resources
    423. 

  423. --------------------------
    424. 

  424. - [JSDB.io](http://www.jsdb.io) - The Database of JavaScript Libraries
    425. 

  425. - [JS Recipes](http://sahatyalkabov.com/jsrecipes) - JavaScript tutorials for backend and frontend development.
    426. 

  426. - [Jade Syntax Documentation by Example](http://naltatis.github.io/jade-syntax-docs/#attributes) - Even better than official Jade docs.
    427. 

  427. - [HTML to Jade converter](http://html2jade.aaron-powell.com) - Extremely valuable when you need to quickly copy and paste HTML snippets from the web.
    428. 

  428. - [JavascriptOO](http://www.javascriptoo.com/) - A directory of JavaScript libraries with examples, CDN links, statistics, and videos.
    429. 

  429. - [Favicon Generator](http://realfavicongenerator.net/) - Generate favicons for PC, Android, iOS, Windows 8.
    430. 

  430. 

  431. Recommended Design Resources
    432. 

  432. ----------------------------
    433. 

  433. - [Code Guide](http://codeguide.co/) - Standards for developing flexible, durable, and sustainable HTML and CSS.
    434. 

  434. - [Bootsnipp](http://bootsnipp.com/) - Code snippets for Bootstrap.
    435. 

  435. - [UIBox](http://www.uibox.in) - Curated HTML, CSS, JS, UI components.
    436. 

  436. - [Bootstrap Zero](http://bootstrapzero.com/) - Free Bootstrap templates themes.
    437. 

  437. - [Google Bootstrap](http://todc.github.io/todc-bootstrap/) - Google-styled theme for Bootstrap.
    438. 

  438. - [Font Awesome Icons](http://fortawesome.github.io/Font-Awesome/icons/) - It's already part of the Hackathon Starter, so use this page as a reference.
    439. 

  439. - [Colors](http://clrs.cc) - A nicer color palette for the web.
    440. 

  440. - [Creative Button Styles](http://tympanus.net/Development/CreativeButtons/) - awesome button styles.
    441. 

  441. - [Creative Link Effects](http://tympanus.net/Development/CreativeLinkEffects/) - Beautiful link effects in CSS.
    442. 

  442. - [Medium Scroll Effect](http://codepen.io/andreasstorm/pen/pyjEh) - Fade in/out header background image as you scroll.
    443. 

  443. - [GeoPattern](https://github.com/btmills/geopattern) - SVG background pattern generator.
    444. 

  444. - [Trianglify](https://github.com/qrohlf/trianglify) - SVG low-poly background pattern generator.
    445. 

  445. 

  446. 

  447. Recommended Node.js Libraries
    448. 

  448. -----------------------------
    449. 

  449. 

  450. - [Nodemon](https://github.com/remy/nodemon) - Automatically restart Node.js server on code changes.
    451. 

  451. - [geoip-lite](https://github.com/bluesmoon/node-geoip) - Geolocation coordinates from IP address.
    452. 

  452. - [Filesize.js](http://filesizejs.com/) - Pretty file sizes, e.g. `filesize(265318); // "265.32 kB"`.
    453. 

  453. - [Numeral.js](http://numeraljs.com) - Library for formatting and manipulating numbers.
    454. 

  454. - [Node Inspector](https://github.com/node-inspector/node-inspector) - Node.js debugger based on Chrome Developer Tools.
    455. 

  455. - [node-taglib](https://github.com/nikhilm/node-taglib) - Library for reading the meta-data of several popular audio formats.
    456. 

  456. - [sharp](https://github.com/lovell/sharp) - Node.js module for resizing JPEG, PNG, WebP and TIFF images.
    457. 

  457. 

  458. Recommended Client-side Libraries
    459. 

  459. ---------------------------------
    460. 

  460. 

  461. - [Framework7](http://www.idangero.us/framework7) - Full Featured HTML Framework For Building iOS7 Apps.
    462. 

  462. - [InstantClick](http://instantclick.io) - Makes your pages load instantly by pre-loading them on mouse hover.
    463. 

  463. - [NProgress.js](https://github.com/rstacruz/nprogress) - Slim progress bars like on YouTube and Medium.
    464. 

  464. - [Hover](https://github.com/IanLunn/Hover) - Awesome CSS3 animations on mouse hover.
    465. 

  465. - [Magnific Popup](http://dimsemenov.com/plugins/magnific-popup/) - Responsive jQuery Lightbox Plugin.
    466. 

  466. - [jQuery Raty](http://wbotelhos.com/raty/) - Star Rating Plugin.
    467. 

  467. - [Headroom.js](http://wicky.nillia.ms/headroom.js/) - Hide your header until you need it.
    468. 

  468. - [X-editable](http://vitalets.github.io/x-editable/) - Edit form elements inline.
    469. 

  469. - [Offline.js](http://github.hubspot.com/offline/docs/welcome/) - Detect when user's internet connection goes offline.
    470. 

  470. - [Alertify.js](http://fabien-d.github.io/alertify.js/) - Sweet looking alerts and browser dialogs.
    471. 

  471. - [selectize.js](http://brianreavis.github.io/selectize.js/) - Styleable select elements and input tags.
    472. 

  472. - [drop.js](http://github.hubspot.com/drop/docs/welcome/) -  Powerful Javascript and CSS library for creating dropdowns and other floating displays.
    473. 

  473. - [scrollReveal.js](https://github.com/julianlloyd/scrollReveal.js) - Declarative on-scroll reveal animations.
    474. 

  474. 

  475. Pro Tips
    476. 

  476. --------
    477. 

  477. 

  478. - When installing an NPM package, add a *--save* flag, and it will be automatically
    479. 

  479. added to `package.json` as well. For example, `npm install --save moment`.
    480. 

  480. - Use [async.parallel()](https://github.com/caolan/async#parallel) when you need to run multiple
    481. 

  481. asynchronous tasks, and then render a page, but only when all tasks are completed. For example, you might
    482. 

  482. want to scrape 3 different websites for some data and render the results in a template
    483. 

  483. after all 3 websites have been scraped.
    484. 

  484. - Need to find a specific object inside an Array? Use [_.find](http://lodash.com/docs#find)
    485. 

  485. function from Lodash. For example, this is how you would retrieve a
    486. 

  486. Twitter token from database: `var token = _.find(req.user.tokens, { kind: 'twitter' });`,
    487. 

  487. where 1st parameter is an array, and a 2nd parameter is an object to search for.
    488. 

  488. 

  489. FAQ
    490. 

  490. ---
    491. 

  491. 

  492. ### Why do I get `403 Error: Forbidden` when submitting a form?
    493. 

  493. You need to add the following hidden input element to your form. This has been
    494. 

  494. added in the [pull request #40](https://github.com/sahat/hackathon-starter/pull/40)
    495. 

  495. as part of the CSRF protection.
    496. 

  496. 

  497. ```
    498. 

  498. input(type='hidden', name='_csrf', value=_csrf)
    499. 

  499. ```
    500. 

  500. 

  501. **Note:** It is now possible to whitelist certain URLs. In other words you can
    502. 

  502. specify a list of routes that should bypass CSRF verification check.
    503. 

  503. 

  504. **Note 2:** To whitelist dynamic URLs use regular expression tests inside the
    505. 

  505. CSRF middleware to see if `req.originalUrl` matches your desired pattern.
    506. 

  506. 

  507. ### What is cluster_app.js?
    508. 

  508. 

  509. **Note**: It is now part of the generator as of **v2.1**.
    510. 

  510. 

  511. From the [Node.js Documentation](http://nodejs.org/api/cluster.html#cluster_how_it_works):
    512. 

  512. > A single instance of Node runs in a single thread. To take advantage of multi-core systems
    513. 

  513. > the user will sometimes want to launch a cluster of Node processes to handle the load.
    514. 

  514. > The cluster module allows you to easily create child processes that all share server ports.
    515. 

  515. 

  516. Running `cluster_app.js` allows you to take advantage of this feature by forking
    517. 

  517. a process of `app.js` for each detected CPU. For the majority of applications
    518. 

  518. serving HTTP requests, this is a nice benefit. However, the cluster module is
    519. 

  519. still in experimental stage, therefore it should only be used after understanding
    520. 

  520. its purpose and behavior. To use it, simply run `node cluster_app.js`.
    521. 

  521. **Its use is entirely optional and `app.js` is not tied in any way to it**.
    522. 

  522. As a reminder, if you plan to use `cluster_app.js` instead of `app.js`,
    523. 

  523. be sure to indicate that in `package.json` when you are ready to deploy your app.
    524. 

  524. 

  525. ### What is this Rails 3.1-style asset pipeline that you mentioned under Features?
    526. 

  526. This is how you typically define static files inside HTML, Jade or any template
    527. 

  527. for that matter:
    528. 

  528. 

  529. ```jade
    530. 

  530. link(href='/css/styles.css', rel='stylesheet')
    531. 

  531. script(src='/js/lib/jquery-2.1.0.min.js')
    532. 

  532. script(src='/js/lib/bootstrap.min.js')
    533. 

  533. script(src='/js/main.js')
    534. 

  534. ```
    535. 

  535. 

  536. Simple enough right? But wouldn't it be nice to have it just like that in
    537. 

  537. development mode, but when you deploy your app to production, have it minified
    538. 

  538. and concatenated into a single file automatically without any extra effort on
    539. 

  539. your part?
    540. 

  540. 

  541. ```jade
    542. 

  542. link(href='/css/styles.css', rel='stylesheet')
    543. 

  543. script(src='/js/application.js')
    544. 

  544. ```
    545. 

  545. 

  546. As soon as you start bringing in more JavaScript libraries, the benefits of
    547. 

  547. concatenating and minifying JavaScript files will be even greater. Using
    548. 

  548. **connect-assets** library, it is  as as simple as declaring these two lines:
    549. 

  549. 

  550. ```
    551. 

  551. != css('styles')      // expects public/css/styles.less
    552. 

  552. != js('application')  // expects public/js/application.js
    553. 

  553. ```
    554. 

  554. 

  555. **Tip:** We can use `css` and `js` functions in Jade templates because in
    556. 

  556. **connect-assets** middleware options we have added this line: `helperContext: app.locals`.
    557. 

  557. 

  558. The only thing you need to remember is to define your JavaScript files inside
    559. 

  559. `public/js/application.js` using this strange syntax notation (Sprockets-style)
    560. 

  560. borrowed from Rails. I know it's an extra thing to learn for someone who has
    561. 

  561. never seen Rails asset pipeline before, but in this case, I think benefits
    562. 

  562. outweigh the cost.
    563. 

  563. 

  564. ```js
    565. 

  565. //= require lib/jquery-2.1.0.min
    566. 

  566. //= require lib/bootstrap.min
    567. 

  567. //= require main
    568. 

  568. ```
    569. 

  569. 

  570. Using this approach, when working in development mode, **connect-assets** will
    571. 

  571. load each file individually, without minifying or concatenating anything.
    572. 

  572. When you deploy your app, it will run in production mode, and so **connect-assets**
    573. 

  573. will automatically serve a single concatenated & minified `application.js`.
    574. 

  574. For more information see [Sprockets-style concatenation](https://github.com/adunkman/connect-assets/#sprockets-style-concatenation)
    575. 

  575. section.
    576. 

  576. 

  577. ### I am getting MongoDB Connection Error, how do I fix it?
    578. 

  578. That's a custom error message defined in `app.js` to indicate that there was a
    579. 

  579. problem connecting to MongoDB:
    580. 

  580. 

  581. ```js
    582. 

  582. mongoose.connection.on('error', function() {
    583. 

  583.   console.error('✗ MongoDB Connection Error. Please make sure MongoDB is running.');
    584. 

  584. });
    585. 

  585. ```
    586. 

  586. You need to have a MongoDB server running before launching `app.js`. You can
    587. 

  587. download MongoDB [here](mongodb.org/downloads), or install it via a package manager.
    588. 

  588. <img src="http://dc942d419843af05523b-ff74ae13537a01be6cfec5927837dcfe.r14.cf1.rackcdn.com/wp-content/uploads/windows-8-50x50.jpg" height="17">
    589. 

  589. Windows users, read [Install MongoDB on Windows](http://docs.mongodb.org/manual/tutorial/install-mongodb-on-windows/).
    590. 

  590. 

  591. **Tip:** If you are always connected to the internet, you could just use
    592. 

  592. [MongoLab](https://mongolab.com/) or [Compose](https://www.compose.io/) instead
    593. 

  593. of downloading and installing MongoDB locally. You will only need to update the
    594. 

  594. `db` property in `config/secrets.js`.
    595. 

  595. 

  596. ### I get an error when I deploy my app, why?
    597. 

  597. Chances are you haven't changed the *Database URI* in `secrets.js`. If `db` is
    598. 

  598. set to `localhost`, it will only work on your machine as long as MongoDB is
    599. 

  599. running. When you deploy to Heroku, OpenShift or some other provider, you will not have MongoDB
    600. 

  600. running on `localhost`. You need to create an account with [MongoLab](http://mongolab.com)
    601. 

  601. or [Compose](https://www.compose.io/), then create a free tier database.
    602. 

  602. See [Deployment](#deployment) for more information on how to setup an account
    603. 

  603. and a new database step-by-step with MongoLab.
    604. 

  604. 

  605. ### Why Jade instead of Handlebars?
    606. 

  606. When I first started this project I didn't have any experience with Handlebars. Since then I have worked on Ember.js apps and got myself familiar with the Handlebars syntax. While it is true Handlebars is easier, because it looks like good old HTML, I have no regrets picking Jade over Handlebars. First off, it's the default template engine in Express, so someone who has built Express apps in the past already knows it. Secondly, I find `extends` and `block` to be indispensable, which as far as I know, Handlebars does not have out of the box. And lastly, subjectively speaking, Jade looks much cleaner and shorter than Handlebars, or any non-HAML style for that matter.
    607. 

  607. 

  608. ### Why do you have all routes defined in app.js?
    609. 

  609. For the sake of simplicity. While there might be a better approach,
    610. 

  610. such as passing `app` context to each controller as outlined in this
    611. 

  611. [blog](http://timstermatic.github.io/blog/2013/08/17/a-simple-mvc-framework-with-node-and-express/),
    612. 

  612. I find such style to be confusing for beginners.
    613. 

  613. It took me a long time to grasp the concept of `exports` and `module.exports`,
    614. 

  614. let alone having a global `app` reference in other files.
    615. 

  615. That to me is a backward thinking.
    616. 

  616. The `app.js` is the "heart of the app", it should be the one referencing
    617. 

  617. models, routes, controllers, etc.
    618. 

  618. When working solo on small projects I actually prefer to have everything inside `app.js` as is the case with [this]((https://github.com/sahat/ember-sass-express-starter/blob/master/app.js))
    619. 

  619. REST API server.
    620. 

  620. 

  621. ### I don't need a sticky footer, can I delete it?
    622. 

  622. Absolutely. But unlike a regular footer there is a bit more work involved.
    623. 

  623. First, delete `#wrap` and `#footer` ID selectors and `html, body { height: 100%; }`
    624. 

  624. from **styles.less**. Next, delete `#wrap` and `#footer` lines from **layout.jade**
    625. 

  625. (By the way, if no element is specified before class or id, Jade assumes it is
    626. 

  626. a `div` element). Don't forget to indent everything under `#wrap` to the left
    627. 

  627. once, since this project uses two spaces per block indentation.
    628. 

  628. 

  629. ### Why is there no Mozilla Persona as a sign-in option?
    630. 

  630. If you would like to use **Persona** authentication strategy, use the
    631. 

  631. [pull request #64](https://github.com/sahat/hackathon-starter/pull/64) as a
    632. 

  632. reference guide. I have explained my reasons why it could not be merged in
    633. 

  633. [issue #63](https://github.com/sahat/hackathon-starter/issues/63#issuecomment-34898290).
    634. 

  634. 

  635. ### How do I switch SendGrid for another email delivery service?
    636. 

  636. Run `node setup.js` bundled with Hackathon Starter, then select
    637. 

  637. **Email Service** option. It will automatically replace appropriate strings in
    638. 

  638. your code. Currently there are three options: SendGrid, Mandrill, and Mailgun.
    639. 

  639. 

  640. ### Can I use Sass instead of LESS stylesheets?
    641. 

  641. Yes you can! Although you will have to manually convert all existing stylesheets
    642. 

  642. to Sass, which shouldn't be too hard considering how similar Sass and LESS are.
    643. 

  643. Simply rename `styles.less` to `styles.scss` and **connect-assets** will
    644. 

  644. automatically use Sass preprocessor.
    645. 

  645. 

  646. Your are not limited to just Sass *or* LESS, you could use both if you want to.
    647. 

  647. In **layout.jade** simply specify LESS and Sass stylesheets separately:
    648. 

  648. ```jade
    649. 

  649. != css('styles') # public/css/styles.less
    650. 

  650. != css('my_sass_styles') # public/css/my_sass_styles.scss
    651. 

  651. ```
    652. 

  652. 

  653. And as I already mentioned you do not need to specify the file extension,
    654. 

  654. **connect-assets** will automatically figure out which CSS preprocessor to use
    655. 

  655. based on the filetype.
    656. 

  656. 

  657. **Note:** I did not include `node-sass` module in *package.json*, so you will
    658. 

  658. have to install it yourself by running `npm install --save node-sass`.
    659. 

  659. 

  660. 

  661. How It Works (mini guides)
    662. 

  662. --------------------------
    663. 

  663. 

  664. This section is intended for giving you a detailed explanation about
    665. 

  665. how a particular functionality works. Maybe you are just curious about
    666. 

  666. how it works, or maybe you are lost and confused while reading the code,
    667. 

  667. I hope it provides some guidance to you.
    668. 

  668. 

  669. ###Custom HTML and CSS Design 101
    670. 

  670. 

  671. [HTML5 UP](http://html5up.net/) has many beautiful templates that you can download for free.
    672. 

  672. 

  673. When you download the ZIP file, it will come with *index.html*, *images*, *css* and *js* folders. So, how do you
    674. 

  674. integrate it with Hackathon Starter? Hackathon Starter uses Bootstrap CSS framework, but these templates do not.
    675. 

  675. Trying to use both CSS files at the same time will likely result in undesired effects.
    676. 

  676. 

  677. **Note:** Using the custom templates approach, you should understand that you cannot reuse any of the views I have created: layout, home page, api browser, login, signup, account management, contact. Those views were built using Bootstrap grid and styles. You will have to manually update the grid using a different syntax provided in the template. **Having said that, you can mix and match if you want to do so: Use Bootstrap for main app interface, and a custom template for a landing page.**
    678. 

  678. 

  679. Let's start from the beginning. For this example I will use [Escape Velocity](http://html5up.net/escape-velocity/) template:
    680. 

  680. ![Alt](http://html5up.net/uploads/images/escape-velocity.jpg)
    681. 

  681. 

  682. **Note:** For the sake of simplicity I will only consider `index.html`, and skip `left-sidebar.html`,
    683. 

  683. `no-sidebar.html`, `right-sidebar.html`.
    684. 

  684. 

  685. Move all javascript files from `html5up-escape-velocity/js` to `public/js`. Then move all css files from `html5up-escape-velocity/css` to `public/css`. And finally, move all images from `html5up-escape-velocity/images` to `public/images` (You could move it to the existing **img** folder, but then you would have to manually change every `img` reference). Grab the contents of `index.html` and paste it into [HTML To Jade](http://html2jade.aaron-powell.com/).
    686. 

  686. 

  687. Create a new file `escape-velocity.jade` and paste the Jade markup in `views` folder.
    688. 

  688. Whenever you see the code `res.render('account/login')` - that means it will search for `views/account/login.jade` file.
    689. 

  689. 

  690. Let's see how it looks. Create a new controller **escapeVelocity** inside `controllers/home.js`:
    691. 

    692. 

  692. ```js
    693. 

  693. exports.escapeVelocity = function(req, res) {
    694. 

  694.   res.render('escape-velocity', {
    695. 

  695.     title: 'Landing Page'
    696. 

  696.   });
    697. 

  697. };
    698. 

  698. ```
    699. 

  699. 

  700. And then create a route in `app.js`. I placed it right after the index controller:
    701. 

  701. ```js
    702. 

  702. app.get('/escape-velocity', homeController.escapeVelocity);
    703. 

  703. ```
    704. 

  704. 

  705. Restart the server (if you are not using **nodemon**), then you should see the new template at [http://localhost:3000/escape-velocity](http://localhost:3000/escape-velocity).
    706. 

  706. 

  707. I will stop right here, but if you would like to use this template as more than just a single page, take a look at how these Jade templates work: `layout.jade` - base template, `index.jade` - home page, `partials/header.jade` - Bootstrap navbar, `partials/footer.jade` - sticky footer. You will have to manually break it apart into smaller pieces. Figure out which part of the template you want to keep the same on all pages - that's your new `layout.jade`.
    708. 

  708. Then, each page that changes, be it `index.jade`, `about.jade`, `contact.jade`
    709. 

  709. will be embedded in your new `layout.jade` via `block content`. Use existing templates as a reference.
    710. 

  710. 

  711. This is a rather lengthy process, and templates you get from elsewhere,
    712. 

  712. might have yet another grid system. That's why I chose *Bootstrap* for the Hackathon Starter.
    713. 

  713.  Many people are already familiar with *Bootstrap*, plus it's easy to get started with it if you have never used *Bootstrap*.
    714. 

  714.  You can also buy many beautifully designed *Bootstrap* themes at [Themeforest](http://themeforest.net/), and use them as a drop-in replacement for Hackathon Starter. However, if you would like to go with a completely custom HTML/CSS design, this should help you to get started!
    715. 

  715. 

  716. <hr>
    717. 

  717. 

  718. ### How do flash messages work in this project?
    719. 

  719. Flash messages allow you to display a message at the end of the request and access
    720. 

  720. it on next request and only next request. For instance, on a failed login attempt, you would
    721. 

  721. display an alert with some error message, but as soon as you refresh that page or visit a different
    722. 

  722. page and come back to the login page, that error message will be gone. It is only displayed once.
    723. 

  723. This project uses *express-flash* module for flash messages. And that
    724. 

  724. module is built on top of *connect-flash*, which is what I used in
    725. 

  725. this project initially. With *express-flash* you don't have to
    726. 

  726. explicity send a flash message to every view inside `res.render()`.
    727. 

  727. All flash messages are available in your views via `messages` object by default,
    728. 

  728. thanks to *express-flash*.
    729. 

  729. 

  730. Flash messages have a two-step process. You use `req.flash('errors', { msg: 'Error messages goes here' }`
    731. 

  731. to create a flash message in your controllers, and then display them in your views:
    732. 

  732. ```jade
    733. 

  733. if messages.errors
    734. 

  734.   .alert.alert-danger.fade.in
    735. 

  735.     for error in messages.errors
    736. 

  736.       div= error.msg
    737. 

  737. ```
    738. 

  738. In the first step, `'errors'` is the name of a flash message, which should match the
    739. 

  739. name of the property on `messages` object in your views. You place alert messages
    740. 

  740. inside `if message.errors` because you don't want to show them flash messages are actually present.
    741. 

  741. The reason why you pass an error like `{ msg: 'Error messages goes here' }` instead
    742. 

  742. of just a string - `'Error messages goes here'`, is for the sake of consistency.
    743. 

  743. To clarify that, *express-validator* module which is used for validating and sanitizing user's input,
    744. 

  744. returns all errors as an array of objects, where each object has a `msg` property with a message
    745. 

  745. why an error has occurred. Here is a more general example of what express-validator returns when there are errors present:
    746. 

  746. 

  747. ```js
    748. 

  748. [
    749. 

  749.   { param: "name", msg: "Name is required", value: "<received input>" },
    750. 

  750.   { param: "email", msg: "A valid email is required", value: "<received input>" }
    751. 

  751. ]
    752. 

  752. ```
    753. 

  753. 

  754. To keep consistent with that style, you should pass all flash messages
    755. 

  755. as `{ msg: 'My flash message' }` instead of a string. Otherwise you will just see an alert box
    756. 

  756. without an error message. That is because, in **partials/flash.jade** template it will try to output
    757. 

  757. `error.msg` (i.e. `"My flash message".msg`), in other words it will try to call a `msg` method on a *String* object,
    758. 

  758. which will return *undefined*. Everything I just mentioned about errors, also applies
    759. 

  759. to "info" and "success" flash messages, and you could even create a new one yourself, such as:
    760. 

  760. 

  761. **Data Usage Controller (Example)**
    762. 

  762. ```
    763. 

  763. req.flash('warning', { msg: 'You have exceeded 90% of your data usage' });
    764. 

  764. ```
    765. 

  765. 

  766. **User Account Page (Example)**
    767. 

  767. ```jade
    768. 

  768. if messages.warning
    769. 

  769.   .alert.alert-warning.fade.in
    770. 

  770.     for warning in messages.warning
    771. 

  771.       div= warning.msg
    772. 

  772. ```
    773. 

  773. 

  774. `partials/flash.jade` is a partial template that contains how flash messages
    775. 

  775. are formatted. Previously, flash
    776. 

  776. messages were scattered throughout each view that used flash messages
    777. 

  777. (contact, login, signup, profile), but now, thankfully it is uses a *DRY* approach.
    778. 

  778. 

  779. The flash messages partial template is *included* in the `layout.jade`, along with footer and navigation.
    780. 

  780. ```jade
    781. 

  781. body
    782. 

  782.   #wrap
    783. 

  783.     include partials/navigation
    784. 

  784.     .container
    785. 

  785.       include partials/flash
    786. 

  786.       block content
    787. 

  787.   include partials/footer
    788. 

  788. ```
    789. 

  789. 

  790. If you have any further questions about flash messages,
    791. 

  791. please feel free to open an issue and I will update this mini-guide accordingly,
    792. 

  792. or send a pull request if you  would like to include something that I missed.
    793. 

  793. 

  794. <hr>
    795. 

  795. 

  796. ### How do I create a new page?
    797. 

  797. A more correct way to be to say "How do I create a new route". The main file `app.js` contains all the routes.
    798. 

  798. Each route has a callback function associated with it. Sometimes you will see 3 or more arguments
    799. 

  799. to routes. In cases like that, the first argument is still a URL string, while middle arguments
    800. 

  800. are what's called middleware. Think of middleware as a door. If this door prevents you from
    801. 

  801. continuing forward, you won't get to your callback function. One such example is a route that requires authentication.
    802. 

    803. 

  803. ```js
    804. 

  804. app.get('/account', passportConf.isAuthenticated, userController.getAccount);
    805. 

  805. ```
    806. 

  806. 

  807. It always goes from left to right. A user visits `/account` page. Then `isAuthenticated` middleware
    808. 

  808. checks if you are authenticated:
    809. 

  809. 

  810. ```js
    811. 

  811. exports.isAuthenticated = function(req, res, next) {
    812. 

  812.   if (req.isAuthenticated()) {
    813. 

  813.     return next();
    814. 

  814.   }
    815. 

  815.   res.redirect('/login');
    816. 

  816. };
    817. 

  817. ```
    818. 

  818. 

  819. If you are authenticated, you let this visitor pass through your "door" by calling `return next();`. It then proceeds to the
    820. 

  820. next middleware until it reaches the last argument, which is a callback function that typically renders a template on `GET` requests or redirects on `POST` requests. In this case, if you are authenticated, you will be redirected to *Account Management* page, otherwise you will be redirected to *Login* page.
    821. 

  821. 

  822. ```js
    823. 

  823. exports.getAccount = function(req, res) {
    824. 

  824.   res.render('account/profile', {
    825. 

  825.     title: 'Account Management'
    826. 

  826.   });
    827. 

  827. };
    828. 

  828. ```
    829. 

  829. 

  830. Express.js has `app.get`, `app.post`, `app.put`, `app.delete`, but for the most part you will only use the first two HTTP verbs, unless you are building a RESTful API.
    831. 

  831. If you just want to display a page, then use `GET`, if you are submitting a form, sending a file then use `POST`.
    832. 

  832. 

  833. Here is a typical workflow for adding new routes to your application. Let's say we are building
    834. 

  834. a page that lists all books from database.
    835. 

  835. 

  836. **Step 1.** Start by defining a route.
    837. 

  837. ```js
    838. 

  838. app.get('/books', bookController.getBooks);
    839. 

  839. ```
    840. 

  840. 

  841. ---
    842. 

  842. 

  843. **Note:** As of Express 4.x you can define you routes like so:
    844. 

  844. 

  845. ```js
    846. 

  846. app.route('/books')
    847. 

  847.   .get(bookController.getBooks)
    848. 

  848.   .post(bookController.createBooks)
    849. 

  849.   .put(bookController.updateBooks)
    850. 

  850.   .delete(bookController.deleteBooks)
    851. 

  851. ```
    852. 

  852. 

  853. And here is how a route would look if it required an *authentication* and an *authorization* middleware:
    854. 

  854. 

  855. ```js
    856. 

  856. app.route('/api/twitter')
    857. 

  857.   .all(passportConf.isAuthenticated)
    858. 

  858.   .all(passportConf.isAuthorized)
    859. 

  859.   .get(apiController.getTwitter);
    860. 

  860.   .post(apiController.postTwitter)
    861. 

  861. ```
    862. 

  862. 

  863. Use whichever style that makes sense to you. Either one is acceptable. I really think that chaining HTTP verbs on
    864. 

  864. `app.route` is very clean and elegant approach, but on the other hand I can no longer see all my routes at a glance
    865. 

  865. when you have one route per line.
    866. 

  866. 

  867. **Step 2.** Create a new schema and a model `Book.js` inside the *models* directory.
    868. 

  868. ```js
    869. 

  869. var bookSchema = new mongoose.Schema({
    870. 

  870.   name: String
    871. 

  871. });
    872. 

    873. 

  873. var Book = mongoose.model('Book', bookSchema);
    874. 

  874. module.exports = Book;
    875. 

  875. ```
    876. 

  876. 

  877. **Step 3.** Create a new controller file called `book.js` inside the *controllers* directory.
    878. 

  878. ```js
    879. 

  879. /**
    880. 

  880.  * GET /books
    881. 

  881.  * List all books.
    882. 

  882.  */
    883. 

  883. var Book = require('../models/Book.js');
    884. 

    885. 

  885. exports.getBooks = function(req, res) {
    886. 

  886.   Book.find(function(err, docs) {
    887. 

  887.     res.render('books', { books: docs });
    888. 

  888.   });
    889. 

  889. };
    890. 

  890. ```
    891. 

  891. 

  892. **Step 4.** Import that controller in `app.js`.
    893. 

  893. ```js
    894. 

  894. var bookController = require('./controllers/book');
    895. 

  895. ```
    896. 

  896. 

  897. **Step 5.** Create `books.jade` template.
    898. 

  898. ```jade
    899. 

  899. extends layout
    900. 

    901. 

  901. block content
    902. 

  902.   .page-header
    903. 

  903.     h3 All Books
    904. 

    905. 

  905.   ul
    906. 

  906.     for book in books
    907. 

  907.       li= book.name
    908. 

  908. ```
    909. 

  909. 

  910. That's it! I will say that you could have combined Step 1, 2, 3 as following:
    911. 

    912. 

  912. ```js
    913. 

  913. app.get('/books', function(req, res) {
    914. 

  914.   Book.find(function(err, docs) {
    915. 

  915.     res.render('books', { books: docs });
    916. 

  916.   });
    917. 

  917. });
    918. 

  918. ```
    919. 

  919. 

  920. Sure, it's simpler, but as soon as you pass 1000 lines of code in `app.js` it becomes a little difficult to navigate the file.
    921. 

  921. I mean, the whole point of this boilerplate project was to separate concerns, so you could
    922. 

  922. work with your teammates without running into *MERGE CONFLICTS*. Imagine you have 4 developers
    923. 

  923. working on a single `app.js`, I promise you it won't be fun resolving merge conflicts all the time.
    924. 

  924. If you are the only developer then it's fine. But as I said, once it gets up to a certain LoC size, it becomes
    925. 

  925. difficult to maintain everything in a single file.
    926. 

  926. 

  927. That's all there is to it. Express.js is super simple to use.
    928. 

  928. Most of the time you will be dealing with other APIs to do the real work:
    929. 

  929. [Mongoose](http://mongoosejs.com/docs/guide.html) for querying database, socket.io for sending and receiving messages over websockets,
    930. 

  930. sending emails via [Nodemailer](http://www.nodemailer.com/), form validation using [express-validator](https://github.com/ctavan/express-validator) library,
    931. 

  931. parsing websites using [Cheerio](https://github.com/MatthewMueller/cheerio), and etc.
    932. 

  932. 

  933. <hr>
    934. 

  934. 

  935. ### How do I use Socket.io with Hackathon Starter?
    936. 

  936. [Dan Stroot](https://github.com/dstroot) submitted an excellent [pull request](https://github.com/dstroot/hackathon-starter/commit/0a632def1ce8da446709d92812423d337c977d75) that adds a real-time dashboard with socket.io.
    937. 

  937. And as  much as I'd like to add it to the project, I think it violates one of the main
    938. 

  938. principles of the Hackathon Starter:
    939. 

  939. > When I started this project, my primary focus was on simplicity and ease of use.
    940. 

  940. > I also tried to make it as generic and reusable as possible to cover most use cases of
    941. 

  941. > hackathon web apps, **without being too specific**.
    942. 

  942. 

  943. When I need to use socket.io, I **really** need it, but most of the time - I don't. But more
    944. 

  944. importantly, websockets support is still experimental on most hosting providers. As of October 2013,
    945. 

  945. Heroku supports websockets, but not until you opt-in by running this command:
    946. 

  946. 

  947. ```js
    948. 

  948. heroku labs:enable websockets -a myapp
    949. 

  949. ```
    950. 

  950. 

  951. And what if you are deploying to OpenShift? They do support websockets, but it is currently in a
    952. 

  952. preview state. So, for OpenShift you would need to change the socket.io connect URI to the following:
    953. 

  953. 

  954. ```js
    955. 

  955. var socket = io.connect('http://yoursite-namespace.rhcloud.com:8000');
    956. 

  956. ```
    957. 

  957. 

  958. Wait, why is it on port 8000? Who knows, and if I didn't run across this [blog post](http://velin-georgiev-blog.appspot.com/blog/set-up-nodejs-express-socketio-application-using-websockets-on-openshift-by-red-hat/)
    959. 

  959. I wouldn't even know I had to use port 8000.
    960. 

    961. 

  961. I am really glad that Heroku and OpenShift at least
    962. 

  962. have a websockets support, because many other PaaS providers still do not support it.
    963. 

  963. Due to the aforementioned issues with websockets, I cannot include socket.io as part of the Hackathon Starter. *For now...*
    964. 

  964. If you need to use socket.io in your app, please continue reading.
    965. 

  965. 

  966. First you need to install socket.io:
    967. 

  967. ```js
    968. 

  968. npm install socket.io --save
    969. 

  969. ```
    970. 

  970. 

  971. Replace `var app = express();` with the following code:
    972. 

  972. 

  973. ```js
    974. 

  974. var app = express();
    975. 

  975. var server = require('http').Server(app);
    976. 

  976. var io = require('socket.io')(server);
    977. 

  977. ```
    978. 

  978. 

  979. I like to have the following code organization in `app.js` (from top to bottom): module dependencies,
    980. 

  980. import controllers, import configs, connect to database, express configuration, routes,
    981. 

  981. start the server, socket.io stuff. That way I always know where to look for things.
    982. 

  982. 

  983. Add the following code at the end of `app.js`:
    984. 

  984. 

  985. ```js
    986. 

  986. io.on('connection', function(socket) {
    987. 

  987.   socket.emit('greet', { hello: 'Hey there browser!' });
    988. 

  988.   socket.on('respond', function(data) {
    989. 

  989.     console.log(data);
    990. 

  990.   });
    991. 

  991.   socket.on('disconnect', function() {
    992. 

  992.     console.log('Socket disconnected');
    993. 

  993.   });
    994. 

  994. });
    995. 

  995. ```
    996. 

  996. 

  997. One last thing left to change:
    998. 

  998. ```js
    999. 

  999. app.listen(app.get('port'), function() {
    1000. 

  1000. ```
    1001. 

  1001. to
    1002. 

  1002. ```js
    1003. 

  1003. server.listen(app.get('port'), function() {
    1004. 

  1004. ```
    1005. 

  1005. 

  1006. At this point we are done with the back-end.
    1007. 

  1007. 

  1008. You now have a choice - to include your JavaScript code in Jade templates or have all your client-side
    1009. 

  1009. JavaScript in a separate file - in `main.js`. I will admit, when I first started out with Node.js and JavaScript in general,
    1010. 

  1010. I placed all JavaScript code inside templates because I have access to template variables passed in from Express
    1011. 

  1011. right then and there. It's the easiest thing you can do, but also the least efficient and harder to maintain. Since then I
    1012. 

  1012. almost never include inline JavaScript inside templates anymore.
    1013. 

  1013. 

  1014. But it's also understandable if you want take the easier road.
    1015. 

  1015. Most of the time you don't even care about performance during hackathons, you just
    1016. 

  1016. want to [*"get shit done"*](http://www.startupvitamins.com/media/products/13/aaron_levie_poster_black.jpg) before the time runs out.
    1017. 

  1017. Well, either way, use whichever approach makes more sense to you. At the end of the day,
    1018. 

  1018. it's **what** you build that matters, not **how** you build it.
    1019. 

    1020. 

  1020. If you want to stick all your JavaScript inside templates, then in `layout.jade` -
    1021. 

  1021. your main template file, add this to `head` block.
    1022. 

  1022. 

  1023. ```jade
    1024. 

  1024. script(src='/socket.io/socket.io.js')
    1025. 

  1025. script.
    1026. 

  1026.     var socket = io.connect(window.location.href);
    1027. 

  1027.     socket.on('greet', function (data) {
    1028. 

  1028.       console.log(data);
    1029. 

  1029.       socket.emit('respond', { message: 'Hey there, server!' });
    1030. 

  1030.     });
    1031. 

  1031. ```
    1032. 

  1032. 

  1033. **Note:** Notice the path of the `socket.io.js`, you don't actually
    1034. 

  1034. have to have `socket.io.js` file anywhere in your project; it will be generated
    1035. 

  1035. automatically at runtime.
    1036. 

  1036. 

  1037. If you want to have JavaScript code separate from templates, move that inline
    1038. 

  1038. script code into `main.js`, inside the `$(document).ready()` function:
    1039. 

  1039. 

  1040. ```js
    1041. 

  1041. $(document).ready(function() {
    1042. 

    1043. 

  1043.   // Place JavaScript code here...
    1044. 

  1044.   var socket = io.connect(window.location.href);
    1045. 

  1045.   socket.on('greet', function (data) {
    1046. 

  1046.     console.log(data);
    1047. 

  1047.     socket.emit('respond', { message: 'Hello to you too, Mr.Server!' });
    1048. 

  1048.   });
    1049. 

    1050. 

  1050. });
    1051. 

  1051. ```
    1052. 

  1052. 

  1053. And that's it, we are done!
    1054. 

    1055. 

  1055. If you want to see a really cool real-time dashboard check out this
    1056. 

  1056. [live example](http://hackathonstarter.herokuapp.com/dashboard). Refer to the
    1057. 

  1057. [pull request #23](https://github.com/sahat/hackathon-starter/pull/23/files) to
    1058. 

  1058. see how it is implemented.
    1059. 

  1059. 

  1060. Mongoose Cheatsheet
    1061. 

  1061. -------------------
    1062. 

  1062. 

  1063. #### Find all users:
    1064. 

  1064. ```js
    1065. 

  1065. User.find(function(err, users) {
    1066. 

  1066.   console.log(users);
    1067. 

  1067. });
    1068. 

  1068. ```
    1069. 

  1069. 

  1070. #### Find a user by email:
    1071. 

  1071. ```js
    1072. 

  1072. var userEmail = 'example@gmail.com';
    1073. 

  1073. User.findOne({ email: userEmail }, function(err, user) {
    1074. 

  1074.   console.log(user);
    1075. 

  1075. });
    1076. 

  1076. ```
    1077. 

  1077. 

  1078. #### Find 5 most recent user accounts:
    1079. 

  1079. ```js
    1080. 

  1080. User
    1081. 

  1081.   .find()
    1082. 

  1082.   .sort({ _id: -1 })
    1083. 

  1083.   .limit(5)
    1084. 

  1084.   .exec(function(err, users) {
    1085. 

  1085.     console.log(users);
    1086. 

  1086.   });
    1087. 

  1087. ```
    1088. 

  1088. 

  1089. #### Get total count of a field from all documents:
    1090. 

  1090. Let's suppose that each user has a `votes` field and you would like to count
    1091. 

  1091. the total number of votes in your database across all users. One very
    1092. 

  1092. inefficient way would be to loop through each document and manually accumulate
    1093. 

  1093. the count. Or you could use [MongoDB Aggregation Framework](http://docs.mongodb.org/manual/core/aggregation-introduction/) instead:
    1094. 

  1094. 

  1095. ```js
    1096. 

  1096. User.aggregate({ $group: { _id: null, total: { $sum: '$votes' } } }, function(err, votesCount) {
    1097. 

  1097.   console.log(votesCount.total);
    1098. 

  1098. });
    1099. 

  1099. ```
    1100. 

  1100. 

  1101. Deployment
    1102. 

  1102. ----------
    1103. 

  1103. 

  1104. Once you are ready to deploy your app, you will need to create an account with
    1105. 

  1105. a cloud platform to host it. These are not the only choices, but they are my top
    1106. 

  1106. picks. From my experience, **Heroku** is the easiest to get started with, it will
    1107. 

  1107. automatically restart your Node.js process when it crashes, zero-downtime
    1108. 

  1108. deployments and custom domain support on free accounts. Additionally, you can
    1109. 

  1109. create an account with **MongoLab** and then pick one of the *4* providers below.
    1110. 

  1110. Again, there are plenty of other choices and you are not limited to just the ones
    1111. 

  1111. listed below.
    1112. 

  1112. 

  1113. ### 1-Step Deployment with Heroku
    1114. 

  1114. 

  1115. <img src="http://blog.exadel.com/wp-content/uploads/2013/10/heroku-Logo-1.jpg" width="200">
    1116. 

  1116. - Download and install [Heroku Toolbelt](https://toolbelt.heroku.com/)
    1117. 

  1117. - In terminal, run `heroku login` and enter your Heroku credentials
    1118. 

  1118. - From *your app* directory run `heroku create`
    1119. 

  1119. - Run `heroku addons:create mongolab`.  This will set up the MongoLab add-on and configure the `MONGOLAB_URI` environment variable in your Heroku app for you.
    1120. 

  1120. - Lastly, do `git push heroku master`.  Done!
    1121. 

  1121. 

  1122. **Note:** To install Heroku add-ons your account must be verified.
    1123. 

  1123. 

  1124. ---
    1125. 

  1125. 

  1126. <img src="http://i.imgur.com/7KnCa5a.png" width="200">
    1127. 

  1127. - Open [mongolab.com](https://mongolab.com) website
    1128. 

  1128. - Click the yellow **Sign up** button
    1129. 

  1129. - Fill in your user information then hit **Create account**
    1130. 

  1130. - From the dashboard, click on **:zap:Create new** button
    1131. 

  1131. - Select **any** cloud provider (I usually go with AWS)
    1132. 

  1132. - Under *Plan* click on **Single-node (development)** tab and select **Sandbox** (it's free)
    1133. 

  1133.  - *Leave MongoDB version as is - `2.4.x`*
    1134. 

  1134. - Enter *Database name** for your web app
    1135. 

  1135. - Then click on **:zap:Create new MongoDB deployment** button
    1136. 

  1136. - Now, to access your database you need to create a DB user
    1137. 

  1137. - Click to the recently created database
    1138. 

  1138. - You should see the following message:
    1139. 

  1139.  - *A database user is required to connect to this database.* **Click here** *to create a new one.*
    1140. 

  1140. - Click the link and fill in **DB Username** and **DB Password** fields
    1141. 

  1141. - Finally, in `secrets.js` instead of `db: 'localhost'`, use the following URI with your credentials:
    1142. 

  1142.  - `db: 'mongodb://USERNAME:PASSWORD@ds027479.mongolab.com:27479/DATABASE_NAME'`
    1143. 

  1143. 

  1144. **Note:** As an alternative to MongoLab, there is also [Compose](https://www.compose.io/).
    1145. 

  1145. 

  1146. 

  1147. <img src="http://www.opencloudconf.com/images/openshift_logo.png" width="200">
    1148. 

  1148. - First, install this Ruby gem: `sudo gem install rhc` :gem:
    1149. 

  1149. - Run `rhc login` and enter your OpenShift credentials
    1150. 

  1150. - From *your app* directory run `rhc app create MyApp nodejs-0.10`
    1151. 

  1151.  - **Note:** *MyApp* is what you want to name your app (no spaces)
    1152. 

  1152. - Once that is done, you will be provided with **URL**, **SSH** and **Git Remote** links
    1153. 

  1153. - Visit that **URL** and you should see *Welcome to your Node.js application on OpenShift* page
    1154. 

  1154. - Copy **Git Remote** and paste it into `git remote add openshift your_git_remote`
    1155. 

  1155. - Before you push your app, you need to do a few modifications to your code
    1156. 

  1156. 

  1157. Add these two lines to `app.js`, just place them anywhere before `app.listen()`:
    1158. 

  1158. ```js
    1159. 

  1159. var IP_ADDRESS = process.env.OPENSHIFT_NODEJS_IP || '127.0.0.1';
    1160. 

  1160. var PORT = process.env.OPENSHIFT_NODEJS_PORT || 8080;
    1161. 

  1161. ```
    1162. 

  1162. 

  1163. Then change `app.listen()` to:
    1164. 

  1164. ```js
    1165. 

  1165. app.listen(PORT, IP_ADDRESS, function() {
    1166. 

  1166.   console.log("✔ Express server listening on port %d in %s mode", PORT, app.settings.env);
    1167. 

  1167. });
    1168. 

  1168. ```
    1169. 

  1169. Add this to `package.json`, after *name* and *version*. This is necessary because, by default, OpenShift looks for `server.js` file. And by specifying `supervisor app.js` it will automatically restart the server when node.js process crashes.
    1170. 

  1170. 

  1171. ```js
    1172. 

  1172. "main": "app.js",
    1173. 

  1173. "scripts": {
    1174. 

  1174.   "start": "supervisor app.js"
    1175. 

  1175. },
    1176. 

  1176. ```
    1177. 

  1177. 

  1178. - Finally, now you can push your code to OpenShift by running `git push -f openshift master`
    1179. 

  1179.  - **Note:** The first time you run this command, you have to pass `-f` (force) flag because OpenShift creates a dummy server with the welcome page when you create a new Node.js app. Passing `-f` flag will override everything with your *Hackathon Starter* project repository. Please **do not** do `git pull` as it will create unnecessary merge conflicts.
    1180. 

  1180. - And you are done!
    1181. 

  1181. 

  1182. <img src="http://upload.wikimedia.org/wikipedia/commons/f/ff/Windows_Azure_logo.png" width="200">
    1183. 

  1183. 

  1184. - Login to [Windows Azure Management Portal](http://manage.windowsazure.com/)
    1185. 

  1185. - Click the **+ NEW** button on the bottom left of the portal
    1186. 

  1186. - Click **COMPUTE**, then **WEB APP**, then **QUICK CREATE**
    1187. 

  1187. - Enter a name for **URL** and select the datacenter **REGION** for your web site
    1188. 

  1188. - Click on **CREATE WEB APP** button
    1189. 

  1189. - Once the web site status changes to *Running*, click on the name of the web site to access the Dashboard
    1190. 

  1190. - At the bottom right of the Quickstart page, select **Set up a deployment from source control**
    1191. 

  1191. - Select **Local Git repository** from the list, and then click the arrow
    1192. 

  1192. - To enable Git publishing, Azure will ask you to create a user name and password
    1193. 

  1193. - Once the Git repository is ready, you will be presented with a **GIT URL**
    1194. 

  1194. - Inside your *Hackathon Starter* directory, run `git remote add azure [Azure Git URL]`
    1195. 

  1195. - To push your changes simply run `git push azure master`
    1196. 

  1196.  - **Note:** *You will be prompted for the password you created earlier*
    1197. 

  1197. - On **Deployments** tab of your Windows Azure Web App, you will see the deployment history
    1198. 

  1198. 

  1199. <img src="http://www.comparethecloud.net/wp-content/uploads/2014/06/ibm-bluemix_pr-030514.jpg" width="200">
    1200. 

  1200. 

  1201. - Go to [Codename: Bluemix](http://bluemix.net) to signup for the free trial, or login with your *IBM id*
    1202. 

  1202. - Install [Cloud Foundry CLI](https://github.com/cloudfoundry/cli)
    1203. 

  1203. - Navigate to your **hackathon-starter** directory and then run `cf push [your-app-name] -m 512m` command to deploy the application
    1204. 

  1204.  - **Note:** You must specify a unique application name in place of `[your-app-name]`
    1205. 

  1205. - Run `cf create-service mongodb 100 [your-service-name]` to create a [MongoDB service](https://www.ng.bluemix.net/docs/#services/MongoDB/index.html#MongoDB)
    1206. 

  1206. - Run `cf bind-service [your-app-name] [your-service-name]` to associate your application with a service created above
    1207. 

  1207. - Run `cf files [your-app-name] logs/env.log` to see the *environment variables created for MongoDB.
    1208. 

  1208. - Copy the **MongoDB URI** that should look something like the following: `mongodb://68638358-a3c6-42a1-bae9-645b607d55e8:46fb97e6-5ce7-4146-9a5d-d623c64ff1fe@192.155.243.23:10123/db`
    1209. 

  1209. - Then set it as an environment variable for your application by running `cf set-env [your-app-name] MONGODB [your-mongodb-uri]`
    1210. 

  1210. - Run `cf restart [your-app-name]` for the changes to take effect.
    1211. 

  1211. - Visit your starter app at **http://[your-app-name].ng.bluemix.net**
    1212. 

  1212. - Done!
    1213. 

  1213. 

  1214. **Note:** Alternative directions, including how to setup the project with a DevOps pipeline are available at [http://ibm.biz/hackstart](http://ibm.biz/hackstart).
    1215. 

  1215. A longer version of these instructions with screenshots is available at [http://ibm.biz/hackstart2](http://ibm.biz/hackstart2).
    1216. 

  1216. Also, be sure to check out the [Jump-start your hackathon efforts with DevOps Services and Bluemix](https://www.youtube.com/watch?v=twvyqRnutss) video.
    1217. 

  1217. 

  1218. Changelog
    1219. 

  1219. ---------
    1220. 

  1220. 

  1221. ### 3.0.3 (May 14, 2015)
    1222. 

  1222. - Added favicon.
    1223. 

  1223. - Fixed an email issue with Google login.
    1224. 

  1224. 

  1225. ### 3.0.2 (March 31, 2015)
    1226. 

  1226. - Renamed `navbar.jade` to `header.jade`.
    1227. 

  1227. - Fixed typos in README. Thanks @josephahn and @rstormsf.
    1228. 

  1228. - Fix radio button alignment on small screens in Profile page.
    1229. 

  1229. - Increased `bcrypt.genSalt()` from **5** to **10**.
    1230. 

  1230. - Updated package dependencies.
    1231. 

  1231. - Updated Font Awesome `4.3.0`.
    1232. 

  1232. - Updated Bootstrap `3.3.4`.
    1233. 

  1233. - Removed Ionicons.
    1234. 

  1234. - Removed unused `User` variable in *controllers/api.js*.
    1235. 

  1235. - Removed Nodejitsu instructions from README.
    1236. 

  1236. 

  1237. ### 3.0.1 (February 23, 2015)
    1238. 

  1238. - Reverted Sass to LESS stylesheets. See <a href="https://github.com/sahat/hackathon-starter/issues/233">#233</a>.
    1239. 

  1239. - Convert email to lower case in Passport's LocalStrategy during login.
    1240. 

  1240. - New Lob API.
    1241. 

  1241. - Updated Font Awesome to 4.3.0
    1242. 

  1242. - Updated Bootstrap and Flatly theme to 3.3.2.
    1243. 

  1243. 

  1244. ### 3.0.0 (January 11, 2015)
    1245. 

  1245. - New Ordr.in API example.
    1246. 

  1246. - Brought back PayPal API example.
    1247. 

  1247. - Added `xframe` and xssProtection` protection via **lusca** module.
    1248. 

  1248. - No more CSRF route whitelisting, either enable or dsiable it globally.
    1249. 

  1249. - Simplified "remember original destination" middleware.
    1250. 

  1250.  - Instead of excluding certain routes, you now have to "opt-in" for the routes you wish to remember for a redirect after successful authentication.
    1251. 

  1251. - Converted LESS to Sass.
    1252. 

  1252. - Updated Bootstrap to 3.3.1 and Font Awesome to 4.2.0.
    1253. 

  1253. - Updated jQuery to 2.1.3 and Bootstrap to 3.3.1 JS files.
    1254. 

  1254. - Updated Ionicons to 2.0.
    1255. 

  1255. - Faster travis-ci builds using `sudo: false`.
    1256. 

  1256. - Fixed YUI url on Yahoo API example.
    1257. 

  1257. - Fixed `mongo-connect` deprecation warning.
    1258. 

  1258. - Code cleanup throughout the project.
    1259. 

  1259. - Updated `secrets.js` notice.
    1260. 

  1260. - Simplified the generator (`setup.js`), no longer removes auth providers.
    1261. 

  1261. - Added `git remote rm origin` to Getting Started instructions in README.
    1262. 

    1263. 

  1263. ### 2.4.0 (November 8, 2014)
    1264. 

  1264. - Bootstrap 3.3.0.
    1265. 

  1265. - Flatly 3.3.0 theme.
    1266. 

  1266. - User model cleanup.
    1267. 

  1267. - Removed `helperContext` from connect-assets middleware.
    1268. 

    1269. 

  1269. ### 2.3.4 (October 27, 2014)
    1270. 

  1270. - Font Awesome 4.2.0 [01e7bd5c09926911ca856fe4990e6067d9148694](https://github.com/sahat/hackathon-starter/commit/01e7bd5c09926911ca856fe4990e6067d9148694)
    1271. 

  1271. - Code cleanup in `app.js` and `controllers/api.js`. [8ce48f767c0146062296685cc101acf3d5d224d9](https://github.com/sahat/hackathon-starter/commit/8ce48f767c0146062296685cc101acf3d5d224d9) [cdbb9d1888a96bbba92d4d14deec99a8acba2618](https://github.com/sahat/hackathon-starter/commit/cdbb9d1888a96bbba92d4d14deec99a8acba2618)
    1272. 

  1272. - Updated Stripe API example. [afef373cd57b6a44bf856eb093e8f2801fc2dbe2](https://github.com/sahat/hackathon-starter/commit/afef373cd57b6a44bf856eb093e8f2801fc2dbe2)
    1273. 

  1273. - Added 1-step deployment process with Heroku and MongoLab add-on. [c5def7b7b3b98462e9a2e7896dc11aaec1a48b3f](https://github.com/sahat/hackathon-starter/commit/c5def7b7b3b98462e9a2e7896dc11aaec1a48b3f)
    1274. 

  1274. - Updated Twitter apps dashboard url. [e378fbbc24e269de69494d326bc20fcb641c0697](https://github.com/sahat/hackathon-starter/commit/e378fbbc24e269de69494d326bc20fcb641c0697)
    1275. 

  1275. - Fixed dead links in the README. [78fac5489c596e8bcef0ab11a96e654335573bb4](https://github.com/sahat/hackathon-starter/commit/78fac5489c596e8bcef0ab11a96e654335573bb4)
    1276. 

    1277. 

  1277. ### 2.3.3 (September 1, 2014)
    1278. 

  1278. - Use *https* (instead of http) profile image URL with Twitter authentication
    1279. 

    1280. 

  1280. ### 2.3.2 (July 28, 2014)
    1281. 

  1281. - Fixed an issue with connect-assets when running `app.js` from an outside folder
    1282. 

  1282. - Temporarily disabled `setup.js` on Windows platform until [blessed](https://github.com/chjj/blessed) fixes its problems
    1283. 

    1284. 

  1284. ### 2.3.1 (July 15, 2014)
    1285. 

  1285. - Migrated to Nodemailer 1.0
    1286. 

    1287. 

  1287. ### 2.3 (July 2, 2014)
    1288. 

  1288. - Bootstrap 3.2
    1289. 

  1289. - New default theme
    1290. 

  1290. - Ionicons fonts
    1291. 

  1291. - Fixed bodyParser deprecation warning
    1292. 

  1292. - Minor visual updates
    1293. 

  1293. - CSS cleanup via RECESS
    1294. 

  1294. - Replaced `navbar-brand` image with a font icon
    1295. 

    1296. 

  1296. ### 2.2.1 (June 17, 2014)
    1297. 

  1297. - Added IBM Codename: BlueMix deployment instructions
    1298. 

    1299. 

  1299. ### 2.2 (June 6, 2014)
    1300. 

  1300. - Use Lodash instead of Underscore.js
    1301. 

  1301. - Replaced all occurrences of `_.findWhere` with `_.find`
    1302. 

  1302. - Added a flash message when user deletes an account
    1303. 

  1303. - Updated and clarified some comments
    1304. 

  1304. - Updated the Remove Auth message in `setup.js`
    1305. 

  1305. - Cleaned up `styles.less`
    1306. 

  1306. - Redesigned API Examples page
    1307. 

  1307. - Updated Last.fm API example
    1308. 

  1308. - Updated Steam API example
    1309. 

  1309. - Updated Instagram API example
    1310. 

  1310. - Updated Facebook API example
    1311. 

  1311. - Updated jQuery to 2.1.1
    1312. 

  1312. - Fixed a bug that didn't remove Instagram Auth properly
    1313. 

  1313. - Fixed Foursquare secret token
    1314. 

    1315. 

  1315. ### 2.1.4 (June 5, 2014)
    1316. 

  1316. - Fixed a bug related to `returnTo` url (#155)
    1317. 

    1318. 

  1318. ### 2.1.3 (June 3, 2014)
    1319. 

  1319. - Font Awesome 4.1
    1320. 

  1320. - Updated icons on some API examples
    1321. 

  1321. - Use LESS files for *bootstrap-social* and *font-awesome*
    1322. 

    1323. 

  1323. ### 2.1.2 (June 2, 2014)
    1324. 

  1324. - Improved Twilio API example
    1325. 

  1325. - Updated dependencies
    1326. 

    1327. 

  1327. ### 2.1.1 (May 29, 2014)
    1328. 

  1328. - Added **Compose new Tweet** to Twitter API example
    1329. 

  1329. - Fixed email service indentation
    1330. 

  1330. - Fixed Mailgun and Mandrill secret.js properties
    1331. 

  1331. - Renamed `navigation.jade` to `navbar.jade`
    1332. 

    1333. 

  1333. ### 2.1 (May 13, 2014)
    1334. 

  1334. - New and improved generator - **setup.js**
    1335. 

  1335. - Added Yahoo API
    1336. 

  1336. - CSS and templates cleanup
    1337. 

  1337. - Minor improvement to the default theme
    1338. 

  1338. - `cluster_app.js` has been moved into **setup.js**
    1339. 

    1340. 

  1340. ### 2.0.4 (April 26, 2014)
    1341. 

  1341. - Added Mandrill e-mail service (via generator)
    1342. 

    1343. 

  1343. ### 2.0.3 (April 25, 2014)
    1344. 

  1344. - LinkedIn API: Fixed an error if a user did not specify education on LinkedIn
    1345. 

  1345. - Removed email constraint when linking OAuth accounts in order to be able to merge accounts that use the same email address
    1346. 

  1346. - Check if email address is already taken when creating a new local account
    1347. 

  1347.  - Previously relied on Validation Error 11000, which doesn't always work
    1348. 

  1348. - When creating a local account, checks if e-mail address is already taken
    1349. 

  1349. - Flash notifications can now be dismissed by clicking on ×
    1350. 

    1351. 

  1351. ### 2.0.2 (April 22, 2014)
    1352. 

  1352. - Added Instagram Authentication
    1353. 

  1353. - Added Instagram API example
    1354. 

  1354. - Updated Instagram Strategy to use a "fake" email address similar to Twitter Startegy
    1355. 

    1356. 

  1356. ### 2.0.1 (April 18, 2014)
    1357. 

  1357. - Conditional CSRF support using [lusca](https://github.com/krakenjs/lusca)
    1358. 

  1358. - Fixed EOL problem in `generator.js` for Windows users
    1359. 

  1359. - Fixed outdated csrf token string on profile.jade
    1360. 

  1360. - Code cleanup
    1361. 

    1362. 

  1362. ### 2.0.0 (April 15, 2014)
    1363. 

  1363. There are have been over **500+** commits since the initial announcement in
    1364. 

  1364. January 2014 and over a **120** issues and pull requests from **28** contributors.
    1365. 

    1366. 

  1366. - Documentation grew **8x** in size since the announcement on Hacker News
    1367. 

  1367. - Upgraded to Express 4.0
    1368. 

  1368. - Generator for adding/removing authentication providers
    1369. 

  1369. - New Instagram authentication that can be added via generator
    1370. 

  1370. - Forgot password and password reset for Local authentication
    1371. 

  1371. - Added LinkedIn authentication and API example
    1372. 

  1372. - Added Stripe API example
    1373. 

  1373. - Added Venmo API example
    1374. 

  1374. - Added Clockwork SMS example
    1375. 

  1375. - Nicer Facebook API example
    1376. 

  1376. - Pre-populated secrets.js with API keys (not linked to my personal accounts)
    1377. 

  1377. - Grid layout with company logos on API Examples page
    1378. 

  1378. - Added tests (Mocha, Chai, Supertest)
    1379. 

  1379. - Gravatar pictures in Navbar and Profile page
    1380. 

  1380. - Tracks last visited URL before signing in to redirect back to original destination
    1381. 

  1381. - CSRF protection
    1382. 

  1382. - Gzip compression and static assets caching
    1383. 

  1383. - Client-side JavaScript is automatically minified+concatenated in production
    1384. 

  1384. - Navbar, flash messages, footer refactored into partial templates
    1385. 

  1385. - Support for Node.js clusters
    1386. 

  1386. - Support for Mailgun email service
    1387. 

  1387. - Support for environment variables in secrets.js
    1388. 

  1388. - Switched from less-middleware to connect-assets
    1389. 

  1389. - Bug fixes related to multi-authentication login and account linking
    1390. 

  1390. - Other small fixes and changes that are too many to list
    1391. 

    1392. 

  1392. Contributing
    1393. 

  1393. ------------
    1394. 

    1395. 

  1395. If something is unclear, confusing, or needs to be refactored, please let me know.
    1396. 

  1396. Pull requests are always welcome, but due to the opinionated nature of this
    1397. 

  1397. project, I cannot accept every pull request. Please open an issue before
    1398. 

  1398. submitting a pull request. This project uses
    1399. 

  1399. [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) with a
    1400. 

  1400. few minor exceptions. If you are submitting a pull request that involves
    1401. 

  1401. Jade templates, please make sure you are using *spaces*, not tabs.
    1402. 

    1403. 

  1403. License
    1404. 

  1404. -------
    1405. 

    1406. 

  1406. The MIT License (MIT)
    1407. 

    1408. 

  1408. Copyright (c) 2014-2015 Sahat Yalkabov
    1409. 

    1410. 

  1410. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
    1411. 

    1412. 

  1412. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
    1413. 

    1414. 

  1414. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    1415. 

    1416.