{"id":21426307,"url":"https://github.com/phalbert/hackathon-starter","last_synced_at":"2026-04-07T23:31:16.626Z","repository":{"id":84438340,"uuid":"184957251","full_name":"phalbert/hackathon-starter","owner":"phalbert","description":"my new project","archived":false,"fork":false,"pushed_at":"2019-05-05T00:25:38.000Z","size":168,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-16T21:14:57.909Z","etag":null,"topics":["docker","k8s","node"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phalbert.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-05T00:25:35.000Z","updated_at":"2019-07-06T09:57:27.000Z","dependencies_parsed_at":"2023-10-19T06:00:44.078Z","dependency_job_id":null,"html_url":"https://github.com/phalbert/hackathon-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/phalbert/hackathon-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phalbert%2Fhackathon-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phalbert%2Fhackathon-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phalbert%2Fhackathon-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phalbert%2Fhackathon-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phalbert","download_url":"https://codeload.github.com/phalbert/hackathon-starter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phalbert%2Fhackathon-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31533823,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T16:28:08.000Z","status":"ssl_error","status_checked_at":"2026-04-07T16:28:06.951Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","k8s","node"],"created_at":"2024-11-22T21:41:25.434Z","updated_at":"2026-04-07T23:31:16.606Z","avatar_url":"https://github.com/phalbert.png","language":"JavaScript","funding_links":["https://developer.paypal.com"],"categories":[],"sub_categories":[],"readme":"![](https://lh4.googleusercontent.com/-PVw-ZUM9vV8/UuWeH51os0I/AAAAAAAAD6M/0Ikg7viJftQ/w1286-h566-no/hackathon-starter-logo.jpg)\nHackathon Starter\n=======================\n\n[![Dependency Status](https://david-dm.org/sahat/hackathon-starter/status.svg?style=flat)](https://david-dm.org/sahat/hackathon-starter) [![Build Status](https://travis-ci.org/sahat/hackathon-starter.svg?branch=master)](https://travis-ci.org/sahat/hackathon-starter) [![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\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n**Live Demo**: https://hackathon-starter-2018.herokuapp.com\n\nJump to [What's new?](https://github.com/sahat/hackathon-starter/blob/master/CHANGELOG.md)\n\nA boilerplate for **Node.js** web applications.\n\nIf you have attended any hackathons in the past, then you know how much time it takes to\nget a project started: decide on what to build, pick a programming language, pick a web framework,\npick a CSS framework. A while later, you might have an initial project up on GitHub and only then\ncan other team members start contributing. Or how about doing something as simple as *Sign in with Facebook*\nauthentication? You can spend hours on it if you are not familiar with how OAuth 2.0 works.\n\nWhen I started this project, my primary focus was on **simplicity** and **ease of use**.\nI also tried to make it as **generic** and **reusable** as possible to cover most use cases of hackathon web apps,\nwithout being too specific. In the worst case you can use this as a learning guide for your projects,\nif for example you are only interested in **Sign in with Google** authentication and nothing else.\n\n### Testimonials\n\n\u003e [**“Nice! That README alone is already gold!”**](https://www.producthunt.com/tech/hackathon-starter#comment-224732)\u003cbr\u003e\n\u003e — Adrian Le Bas\n\n\u003e [**“Awesome. Simply awesome.”**](https://www.producthunt.com/tech/hackathon-starter#comment-224966)\u003cbr\u003e\n\u003e — Steven Rueter\n\n\u003e [**“I'm using it for a year now and many projects, it's an awesome boilerplate and the project is well maintained!”**](https://www.producthunt.com/tech/hackathon-starter#comment-228610)\u003cbr\u003e\n\u003e — Kevin Granger\n\n\u003e **“Small world with Sahat's project. We were using his hackathon starter for our hackathon this past weekend and got some prizes. Really handy repo!”**\u003cbr\u003e\n\u003e — Interview candidate for one of the companies I used to work with.\n\n\u003ch4 align=\"center\"\u003eModern Theme\u003c/h4\u003e\n\n![](https://lh6.googleusercontent.com/-KQTmCFNK6MM/U7OZpznjDuI/AAAAAAAAERc/h3jR27Uy1lE/w1366-h1006-no/Screenshot+2014-07-02+01.32.22.png)\n\n\u003ch4 align=\"center\"\u003eFlatly Bootstrap Theme\u003c/h4\u003e\n\n![](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)\n\n\u003ch4 align=\"center\"\u003eAPI Examples\u003c/h4\u003e\n\n![](https://lh5.googleusercontent.com/-BJD2wK8CvC8/VLodBsyL-NI/AAAAAAAAEx0/SafE6o_qq_I/w1818-h1186-no/Screenshot%2B2015-01-17%2B00.25.49.png)\n\nTable of Contents\n-----------------\n\n- [Features](#features)\n- [Prerequisites](#prerequisites)\n- [Getting Started](#getting-started)\n- [Obtaining API Keys](#obtaining-api-keys)\n- [Project Structure](#project-structure)\n- [List of Packages](#list-of-packages)\n- [Useful Tools and Resources](#useful-tools-and-resources)\n- [Recommended Design Resources](#recommended-design-resources)\n- [Recommended Node.js Libraries](#recommended-nodejs-libraries)\n- [Recommended Client-side Libraries](#recommended-client-side-libraries)\n- [Pro Tips](#pro-tips)\n- [FAQ](#faq)\n- [How It Works](#how-it-works-mini-guides)\n- [Cheatsheets](#cheatsheets)\n - [ES6](#-es6-cheatsheet)\n - [JavaScript Date](#-javascript-date-cheatsheet)\n - [Mongoose Cheatsheet](#mongoose-cheatsheet)\n- [Deployment](#deployment)\n- [Docker](#docker)\n- [Changelog](#changelog)\n- [Contributing](#contributing)\n- [License](#license)\n\nFeatures\n--------\n\n- **Local Authentication** using Email and Password\n- **OAuth 1.0a Authentication** via Twitter\n- **OAuth 2.0 Authentication** via Facebook, Google, GitHub, LinkedIn, Instagram\n- Flash notifications\n- MVC Project Structure\n- Node.js clusters support\n- Sass stylesheets (auto-compiled via middleware)\n- Bootstrap 4 + Extra Themes\n- Contact Form (powered by Mailgun, Sendgrid or Mandrill)\n- **Account Management**\n - Gravatar\n - Profile Details\n - Change Password\n - Forgot Password\n - Reset Password\n - Link multiple OAuth strategies to one account\n - Delete Account\n- CSRF protection\n- **API Examples**: Facebook, Foursquare, Last.fm, Tumblr, Twitter, Stripe, LinkedIn and more.\n\nPrerequisites\n-------------\n\n- [MongoDB](https://www.mongodb.org/downloads)\n- [Node.js 8.0+](http://nodejs.org)\n- Command Line Tools\n - \u003cimg src=\"http://deluge-torrent.org/images/apple-logo.gif\" height=\"17\"\u003e\u0026nbsp;**Mac OS X:** [Xcode](https://itunes.apple.com/us/app/xcode/id497799835?mt=12) (or **OS X 10.9+**: `xcode-select --install`)\n - \u003cimg src=\"http://dc942d419843af05523b-ff74ae13537a01be6cfec5927837dcfe.r14.cf1.rackcdn.com/wp-content/uploads/windows-8-50x50.jpg\" height=\"17\"\u003e\u0026nbsp;**Windows:** [Visual Studio](https://www.visualstudio.com/products/visual-studio-community-vs) OR [Visaul Studio Code](https://code.visualstudio.com) + [Windows Subsystem for Linux - Ubuntu](https://docs.microsoft.com/en-us/windows/wsl/install-win10)\n - \u003cimg src=\"https://lh5.googleusercontent.com/-2YS1ceHWyys/AAAAAAAAAAI/AAAAAAAAAAc/0LCb_tsTvmU/s46-c-k/photo.jpg\" height=\"17\"\u003e\u0026nbsp;**Ubuntu** / \u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/3/3f/Logo_Linux_Mint.png\" height=\"17\"\u003e\u0026nbsp;**Linux Mint:** `sudo apt-get install build-essential`\n - \u003cimg src=\"http://i1-news.softpedia-static.com/images/extra/LINUX/small/slw218news1.png\" height=\"17\"\u003e\u0026nbsp;**Fedora**: `sudo dnf groupinstall \"Development Tools\"`\n - \u003cimg src=\"https://en.opensuse.org/images/b/be/Logo-geeko_head.png\" height=\"17\"\u003e\u0026nbsp;**OpenSUSE:** `sudo zypper install --type pattern devel_basis`\n\n**Note:** If you are new to Node or Express, I recommend to watch\n[Node.js and Express 101](https://www.youtube.com/watch?v=BN0JlMZCtNU)\nscreencast by Alex Ford that teaches Node and Express from scratch. Alternatively,\nhere is another great tutorial for complete beginners - [Getting Started With Node.js, Express, MongoDB](http://cwbuecheler.com/web/tutorials/2013/node-express-mongo/).\n\nGetting Started\n---------------\n\nThe easiest way to get started is to clone the repository:\n\n```bash\n# Get the latest snapshot\ngit clone https://github.com/sahat/hackathon-starter.git myproject\n\n# Change directory\ncd myproject\n\n# Install NPM dependencies\nnpm install\n\n# Then simply start your app\nnode app.js\n```\n\n**Warning:** If you want to use some api that need https to work (for example pinterest or facebook),\nyou will need to download [ngrok](https://ngrok.com/).\nYou must start ngrok after starting the project.\n\n```bash\n# start ngrok to intercept the data exchanged on port 8080\n./ngrok http 8080\n```\n\nNext, you must use the https url defined by ngrok, for example `https://hackaton.ngrok.io`\n\n**Note:** I highly recommend installing [Nodemon](https://github.com/remy/nodemon).\nIt watches for any changes in your node.js app and automatically restarts the\nserver. Once installed, instead of `node app.js` use `nodemon app.js`. It will\nsave you a lot of time in the long run, because you won't need to manually\nrestart the server each time you make a small change in code. To install, run\n`sudo npm install -g nodemon`.\n\nObtaining API Keys\n------------------\n\nTo use any of the included APIs or OAuth authentication methods, you will need\nto obtain appropriate credentials: Client ID, Client Secret, API Key, or\nUsername \u0026 Password. You will need to go through each provider to generate new\ncredentials.\n\n**Hackathon Starter 2.0 Update:** I have included dummy keys and passwords for\nall API examples to get you up and running even faster. But don't forget to update\nthem with *your credentials* when you are ready to deploy an app.\n\n\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/2/2f/Google_2015_logo.svg/1000px-Google_2015_logo.svg.png\" width=\"200\"\u003e\n\n- Visit \u003ca href=\"https://cloud.google.com/console/project\" target=\"_blank\"\u003eGoogle Cloud Console\u003c/a\u003e\n- Click on the **Create Project** button\n- Enter *Project Name*, then click on **Create** button\n- Then click on *APIs \u0026 auth* in the sidebar and select *API* tab\n- Click on **Google+ API** under *Social APIs*, then click **Enable API**\n- Next, under *APIs \u0026 auth* in the sidebar click on *Credentials* tab\n- Click on **Create new Client ID** button\n- Select *Web Application* and click on **Configure Consent Screen**\n- Fill out the required fields then click on **Save**\n- In the *Create Client ID* modal dialog:\n - **Application Type**: Web Application\n - **Authorized Javascript origins**: http://localhost:8080\n - **Authorized redirect URI**: http://localhost:8080/auth/google/callback\n- Click on **Create Client ID** button\n- Copy and paste *Client ID* and *Client secret* keys into `.env`\n\n**Note:** When you ready to deploy to production don't forget to\nadd your new url to *Authorized Javascript origins* and *Authorized redirect URI*,\ne.g. `http://my-awesome-app.herokuapp.com` and\n`http://my-awesome-app.herokuapp.com/auth/google/callback` respectively.\nThe same goes for other providers.\n\n\u003chr\u003e\n\n\u003cimg src=\"https://seeklogo.com/images/S/snapchat-logo-F20CDB1199-seeklogo.com.png\" height=\"90\"\u003e\n\n- Visit \u003ca href=\"https://kit.snapchat.com/portal\" target=\"_blank\"\u003eSnap Kit Developer Portal\u003c/a\u003e\n- Click on the **+** button to create an app\n- Enter a name for your app\n- Enable the scopes that you will want to use in your app\n- Click on the **Continue** button\n- Find the **Kits** section and make sure that **Login Kit** is enabled\n- Find the **Redirect URLs** section, click the **+ Add** button, and enter `http://localhost:8080/auth/snapchat/callback`\n- Find the **Development Environment** section. Click the **Generate** button next to the *Confidential OAuth2 Client* heading within it.\n- Copy and paste the generated *Private Key* and *OAuth2 Client ID* keys into `.env`\n- **Note:** *OAuth2 Client ID* is **SNAPCHAT_ID**, *Private Key* is **SNAPCHAT_SECRET** in `.env`\n- To prepare the app for submission, fill out the rest of the required fields: *Category*, *Description*, *Privacy Policy Url*, and *App Icon*\n\n**Note:** For production use, don't forget to:\n\n- generate a *Confidential OAuth2 Client* in the **Production Environment** and use the production *Private Key* and *OAuth2 Client ID*\n- add the production url to **Redirect URLs** section, e.g. `http://my-awesome-app.herokuapp.com/auth/snapchat/callback`\n- submit the app for review and wait for approval\n\n\u003chr\u003e\n\n\u003cimg src=\"http://www.doit.ba/img/facebook.jpg\" width=\"200\"\u003e\n\n- Visit \u003ca href=\"https://developers.facebook.com/\" target=\"_blank\"\u003eFacebook Developers\u003c/a\u003e\n- Click **My Apps**, then select **Add a New App* from the dropdown menu\n- Enter a new name for your app\n- Click on the **Create App ID** button\n- Find the Facebook Login Product and click on **Facebook Login**\n- Instead of going through their Quickstart, click on **Settings** for your app in the top left corner\n- Copy and paste *App ID* and *App Secret* keys into `.env`\n- **Note:** *App ID* is **FACEBOOK_ID**, *App Secret* is **FACEBOOK_SECRET** in `.env`\n- Enter `localhost` under *App Domains*\n- Choose a **Category** that best describes your app\n- Click on **+ Add Platform** and select **Website**\n- Enter `http://localhost:8080` under *Site URL*\n- Click on the *Settings* tab in the left nav under Facebook Login\n- Enter `http://localhost:8080/auth/facebook/callback` under Valid OAuth redirect URIs\n\n**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.\n\n\u003chr\u003e\n\n\u003cimg src=\"https://github.global.ssl.fastly.net/images/modules/logos_page/GitHub-Logo.png\" width=\"200\"\u003e\n\n- Go to \u003ca href=\"https://github.com/settings/profile\" target=\"_blank\"\u003eAccount Settings\u003c/a\u003e\n- Select **Developer settings** from the sidebar\n- Then inside click on **Register new application**\n- Enter *Application Name* and *Homepage URL*\n- For *Authorization Callback URL*: http://localhost:8080/auth/github/callback\n- Click **Register application**\n- Now copy and paste *Client ID* and *Client Secret* keys into `.env` file\n\n\u003chr\u003e\n\n\u003cimg src=\"https://g.twimg.com/ios_homescreen_icon.png\" width=\"90\"\u003e\n\n- Sign in at \u003ca href=\"https://apps.twitter.com/\" target=\"_blank\"\u003ehttps://apps.twitter.com\u003c/a\u003e\n- Click **Create a new application**\n- Enter your application name, website and description\n- For **Callback URL**: http://127.0.0.1:8080/auth/twitter/callback\n- Go to **Settings** tab\n- Under *Application Type* select **Read and Write** access\n- Check the box **Allow this application to be used to Sign in with Twitter**\n- Click **Update this Twitter's applications settings**\n- Copy and paste *Consumer Key* and *Consumer Secret* keys into `.env` file\n\n\u003chr\u003e\n\n\u003cimg src=\"http://www.danpontefract.com/wp-content/uploads/2014/02/logo-linkedin.png\" width=\"200\"\u003e\n\n- Sign in at \u003ca href=\"https://developer.linkedin.com/\" target=\"_blank\"\u003eLinkedIn Developer Network\u003c/a\u003e\n- From the account name dropdown menu select **API Keys**\n - *It may ask you to sign in once again*\n- Click **+ Add New Application** button\n- Fill out all the *required* fields\n - **OAuth 2.0 Redirect URLs**: http://localhost:8080/auth/linkedin/callback\n - **JavaScript API Domains**: http://localhost:8080\n- For **Default Application Permissions** make sure at least the following is checked:\n - `r_basicprofile`\n- Finish by clicking **Add Application** button\n- Copy and paste *API Key* and *Secret Key* keys into `.env` file\n - *API Key* is your **clientID**\n - *Secret Key* is your **clientSecret**\n\n\u003chr\u003e\n\n\u003cimg src=\"https://stripe.com/img/about/logos/logos/black@2x.png\" width=\"200\"\u003e\n\n- \u003ca href=\"https://stripe.com/\" target=\"_blank\"\u003eSign up\u003c/a\u003e or log into your \u003ca href=\"https://manage.stripe.com\" target=\"_blank\"\u003edashboard\u003c/a\u003e\n- Click on your profile and click on Account Settings\n- Then click on **API Keys**\n- Copy the **Secret Key**. and add this into `.env` file\n\n\u003chr\u003e\n\n\u003cimg src=\"https://pixabay.com/static/uploads/photo/2015/05/26/09/37/paypal-784404_960_720.png\" width=\"200\"\u003e\n\n- Visit \u003ca href=\"https://developer.paypal.com\" target=\"_blank\"\u003ePayPal Developer\u003c/a\u003e\n- Log in to your PayPal account\n- Click **Applications \u003e Create App** in the navigation bar\n- Enter *Application Name*, then click **Create app**\n- Copy and paste *Client ID* and *Secret* keys into `.env` file\n- *App ID* is **client_id**, *App Secret* is **client_secret**\n- Change **host** to api.paypal.com if you want to test against production and use the live credentials\n\n\u003chr\u003e\n\n\u003cimg src=\"http://33.media.tumblr.com/ffaf0075be879b3ab0b87f0b8bcc6814/tumblr_inline_n965bkOymr1qzxhga.png\" width=\"200\"\u003e\n\n- Go to \u003ca href=\"https://developer.foursquare.com\" target=\"_blank\"\u003eFoursquare for Developers\u003c/a\u003e\n- Click on **My Apps** in the top menu\n- Click the **Create A New App** button\n- Enter *App Name*, *Welcome page url*,\n- For **Redirect URI**: http://localhost:8080/auth/foursquare/callback\n- Click **Save Changes**\n- Copy and paste *Client ID* and *Client Secret* keys into `.env` file\n\n\u003chr\u003e\n\n\u003cimg src=\"http://img4.wikia.nocookie.net/__cb20130520163346/logopedia/images/8/8d/Tumblr_logo_by_x_1337_x-d5ikwpp.png\" width=\"200\"\u003e\n\n- Go to \u003ca href=\"http://www.tumblr.com/oauth/apps\" target=\"_blank\"\u003ehttp://www.tumblr.com/oauth/apps\u003c/a\u003e\n- Once signed in, click **+Register application**\n- Fill in all the details\n- For **Default Callback URL**: `http://localhost:8080/auth/tumblr/callback`\n- Click **✔Register**\n- Copy and paste *OAuth consumer key* and *OAuth consumer secret* keys into `.env` file\n\n\u003chr\u003e\n\n\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/a/ae/Steam_logo.svg\" width=\"200\"\u003e\n\n- Go to \u003ca href=\"http://steamcommunity.com/dev/apikey\" target=\"_blank\"\u003ehttp://steamcommunity.com/dev/apikey\u003c/a\u003e\n- Sign in with your existing Steam account\n- Enter your *Domain Name*, then and click **Register**\n- Copy and paste *Key* into `.env` file\n\n\u003chr\u003e\n\n\u003cimg src=\"https://sendgrid.com/brand/sg-logo-300.png\" width=\"200\"\u003e\n\n- Go to \u003ca href=\"https://sendgrid.com/user/signup\" target=\"_blank\"\u003ehttps://sendgrid.com/user/signup\u003c/a\u003e\n- Sign up and **confirm** your account via the *activation email*\n- Then enter your SendGrid *Username* and *Password* into `.env` file\n\n\u003chr\u003e\n\n\u003cimg src=\"https://raw.github.com/mailgun/media/master/Mailgun_Primary.png\" width=\"200\"\u003e\n\n- Go to \u003ca href=\"http://www.mailgun.com\" target=\"_blank\"\u003ehttp://www.mailgun.com\u003c/a\u003e\n- Sign up and add your *Domain Name*\n- From the domain overview, copy and paste the default SMTP *Login* and *Password* into `.env` file\n\n\u003chr\u003e\n\n\u003cimg src=\"https://s3.amazonaws.com/ahoy-assets.twilio.com/global/images/wordmark.svg\" width=\"200\"\u003e\n\n- Go to \u003ca href=\"https://www.twilio.com/try-twilio\" target=\"_blank\"\u003ehttps://www.twilio.com/try-twilio\u003c/a\u003e\n- Sign up for an account.\n- Once logged into the dashboard, expand the link 'show api credentials'\n- Copy your Account Sid and Auth Token\n\nProject Structure\n-----------------\n\n| Name | Description |\n| ---------------------------------- | ------------------------------------------------------------ |\n| **config**/passport.js | Passport Local and OAuth strategies, plus login middleware. |\n| **controllers**/api.js | Controller for /api route and all api examples. |\n| **controllers**/contact.js | Controller for contact form. |\n| **controllers**/home.js | Controller for home page (index). |\n| **controllers**/user.js | Controller for user account management. |\n| **models**/User.js | Mongoose schema and model for User. |\n| **public**/ | Static assets (fonts, css, js, img). |\n| **public**/**js**/application.js | Specify client-side JavaScript dependencies. |\n| **public**/**js**/main.js | Place your client-side JavaScript here. |\n| **public**/**css**/main.scss | Main stylesheet for your app. |\n| **public/css/themes**/default.scss | Some Bootstrap overrides to make it look prettier. |\n| **views/account**/ | Templates for *login, password reset, signup, profile*. |\n| **views/api**/ | Templates for API Examples. |\n| **views/partials**/flash.pug | Error, info and success flash notifications. |\n| **views/partials**/header.pug | Navbar partial template. |\n| **views/partials**/footer.pug | Footer partial template. |\n| **views**/layout.pug | Base template. |\n| **views**/home.pug | Home page template. |\n| .dockerignore | Folder and files ignored by docker usage. |\n| .env.example | Your API keys, tokens, passwords and database URI. |\n| .eslintrc | Rules for eslint linter. |\n| .gitignore | Folder and files ignored by git. |\n| .travis.yml | Configuration files for continue integration. |\n| app.js | The main application file. |\n| docker-compose.yml | Docker compose configuration file. |\n| Dockerfile | Docker configuration file. |\n| package.json | NPM dependencies. |\n| package-lock.json | Contains exact versions of NPM dependencies in package.json. |\n\n**Note:** There is no preference how you name or structure your views.\nYou could place all your templates in a top-level `views` directory without\nhaving a nested folder structure, if that makes things easier for you.\nJust don't forget to update `extends ../layout` and corresponding\n`res.render()` paths in controllers.\n\nList of Packages\n----------------\n\n| Package | Description |\n| ------------------------------- | ------------------------------------------------------------------------|\n| @octokit/rest | GitHub API library. |\n| bcrypt-nodejs | Library for hashing and salting user passwords. |\n| body-parser | Node.js body parsing middleware. |\n| chai | BDD/TDD assertion library. |\n| chalk | Terminal string styling done right. |\n| cheerio | Scrape web pages using jQuery-style syntax. |\n| clockwork | Clockwork SMS API library. |\n| compression | Node.js compression middleware. |\n| connect-mongo | MongoDB session store for Express. |\n| dotenv | Loads environment variables from .env file. |\n| errorhandler | Development-only error handler middleware. |\n| eslint | Linter JavaScript. |\n| eslint-config-airbnb-base | Configuration eslint by airbnb. |\n| eslint-plugin-chai-friendly | Makes eslint friendly towards Chai.js 'expect' and 'should' statements. |\n| eslint-plugin-import | ESLint plugin with rules that help validate proper imports. |\n| express | Node.js web framework. |\n| express-flash | Provides flash messages for Express. |\n| express-session | Simple session middleware for Express. |\n| express-status-monitor | Reports real-time server metrics for Express. |\n| express-validator | Easy form validation for Express. |\n| fbgraph | Facebook Graph API library. |\n| instagram-node | Instagram API library. |\n| lastfm | Last.fm API library. |\n| lob | Lob API library. |\n| lusca | CSRF middleware. |\n| mocha | Test framework. |\n| mongoose | MongoDB ODM. |\n| morgan | HTTP request logger middleware for node.js. |\n| multer | Node.js middleware for handling `multipart/form-data`. |\n| node-foursquare | Foursquare API library. |\n| node-linkedin | LinkedIn API library. |\n| node-sass | Node.js bindings to libsass. |\n| node-sass-middleware | Sass middleware compiler. |\n| nyc | Coverage test. |\n| nodemailer | Node.js library for sending emails. |\n| passport | Simple and elegant authentication library for node.js. |\n| passport-facebook | Sign-in with Facebook plugin. |\n| passport-github | Sign-in with GitHub plugin. |\n| passport-google-oauth | Sign-in with Google plugin. |\n| passport-instagram | Sign-in with Instagram plugin. |\n| passport-linkedin-oauth2 | Sign-in with LinkedIn plugin. |\n| passport-local | Sign-in with Username and Password plugin. |\n| passport-openid | Sign-in with OpenId plugin. |\n| passport-oauth | Allows you to set up your own OAuth 1.0a and OAuth 2.0 strategies. |\n| passport-snapchat | Sign-in with Snapchat plugin. |\n| passport-twitter | Sign-in with Twitter plugin. |\n| paypal-rest-sdk | PayPal APIs library. |\n| pug (jade) | Template engine for Express. |\n| request | Simplified HTTP request library. |\n| sinon | Test spies, stubs and mocks for JavaScript. |\n| sinon-mongoose | Extend Sinon stubs for Mongoose methods to test chained methods easily. |\n| stripe | Offical Stripe API library. |\n| supertest | HTTP assertion library. |\n| tumblr.js | Tumblr API library. |\n| twilio | Twilio API library. |\n| twit | Twitter API library. |\n| validator | Used in conjunction with express-validator in **controllers/api.js**. |\n\nUseful Tools and Resources\n--------------------------\n- [JavaScripting](http://www.javascripting.com/) - The Database of JavaScript Libraries\n- [JS Recipes](http://sahatyalkabov.com/jsrecipes/) - JavaScript tutorials for backend and frontend development.\n- [HTML to Pug converter](https://html-to-pug.com/) - HTML to PUG is a free online converter helping you to convert html files to pug syntax in realtime.\n- [JavascriptOO](http://www.javascriptoo.com/) - A directory of JavaScript libraries with examples, CDN links, statistics, and videos.\n- [Favicon Generator](http://realfavicongenerator.net/) - Generate favicons for PC, Android, iOS, Windows 8.\n\nRecommended Design Resources\n----------------------------\n- [Code Guide](http://codeguide.co/) - Standards for developing flexible, durable, and sustainable HTML and CSS.\n- [Bootsnipp](http://bootsnipp.com/) - Code snippets for Bootstrap.\n- [UIBox](http://www.uibox.in) - Curated HTML, CSS, JS, UI components.\n- [Bootstrap Zero](https://www.bootstrapzero.com) - Free Bootstrap templates themes.\n- [Google Bootstrap](http://todc.github.io/todc-bootstrap/) - Google-styled theme for Bootstrap.\n- [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.\n- [Colors](http://clrs.cc) - A nicer color palette for the web.\n- [Creative Button Styles](http://tympanus.net/Development/CreativeButtons/) - awesome button styles.\n- [Creative Link Effects](http://tympanus.net/Development/CreativeLinkEffects/) - Beautiful link effects in CSS.\n- [Medium Scroll Effect](http://codepen.io/andreasstorm/pen/pyjEh) - Fade in/out header background image as you scroll.\n- [GeoPattern](https://github.com/btmills/geopattern) - SVG background pattern generator.\n- [Trianglify](https://github.com/qrohlf/trianglify) - SVG low-poly background pattern generator.\n\n\nRecommended Node.js Libraries\n-----------------------------\n\n- [Nodemon](https://github.com/remy/nodemon) - Automatically restart Node.js server on code changes.\n- [geoip-lite](https://github.com/bluesmoon/node-geoip) - Geolocation coordinates from IP address.\n- [Filesize.js](http://filesizejs.com/) - Pretty file sizes, e.g. `filesize(265318); // \"265.32 kB\"`.\n- [Numeral.js](http://numeraljs.com) - Library for formatting and manipulating numbers.\n- [Node Inspector](https://github.com/node-inspector/node-inspector) - Node.js debugger based on Chrome Developer Tools.\n- [node-taglib](https://github.com/nikhilm/node-taglib) - Library for reading the meta-data of several popular audio formats.\n- [sharp](https://github.com/lovell/sharp) - Node.js module for resizing JPEG, PNG, WebP and TIFF images.\n\nRecommended Client-side Libraries\n---------------------------------\n\n- [Framework7](http://www.idangero.us/framework7/) - Full Featured HTML Framework For Building iOS7 Apps.\n- [InstantClick](http://instantclick.io) - Makes your pages load instantly by pre-loading them on mouse hover.\n- [NProgress.js](https://github.com/rstacruz/nprogress) - Slim progress bars like on YouTube and Medium.\n- [Hover](https://github.com/IanLunn/Hover) - Awesome CSS3 animations on mouse hover.\n- [Magnific Popup](http://dimsemenov.com/plugins/magnific-popup/) - Responsive jQuery Lightbox Plugin.\n- [jQuery Raty](http://wbotelhos.com/raty/) - Star Rating Plugin.\n- [Headroom.js](http://wicky.nillia.ms/headroom.js/) - Hide your header until you need it.\n- [X-editable](http://vitalets.github.io/x-editable/) - Edit form elements inline.\n- [Offline.js](http://github.hubspot.com/offline/docs/welcome/) - Detect when user's internet connection goes offline.\n- [Alertify.js](http://fabien-d.github.io/alertify.js/) - Sweet looking alerts and browser dialogs.\n- [selectize.js](http://brianreavis.github.io/selectize.js/) - Styleable select elements and input tags.\n- [drop.js](http://github.hubspot.com/drop/docs/welcome/) - Powerful Javascript and CSS library for creating dropdowns and other floating displays.\n- [scrollReveal.js](https://github.com/jlmakes/scrollReveal.js) - Declarative on-scroll reveal animations.\n\nPro Tips\n--------\n\n- When installing an NPM package, add a *--save* flag, and it will be automatically\nadded to `package.json` as well. For example, `npm install --save moment`.\n- Use [async.parallel()](https://github.com/caolan/async#parallel) when you need to run multiple\nasynchronous tasks, and then render a page, but only when all tasks are completed. For example, you might\nwant to scrape 3 different websites for some data and render the results in a template\nafter all 3 websites have been scraped.\n- Need to find a specific object inside an Array? Use [_.find](http://lodash.com/docs#find)\nfunction from Lodash. For example, this is how you would retrieve a\nTwitter token from database: `var token = _.find(req.user.tokens, { kind: 'twitter' });`,\nwhere 1st parameter is an array, and a 2nd parameter is an object to search for.\n\nFAQ\n---\n\n### Why do I get `403 Error: Forbidden` when submitting a form?\nYou need to add the following hidden input element to your form. This has been\nadded in the [pull request #40](https://github.com/sahat/hackathon-starter/pull/40)\nas part of the CSRF protection.\n\n```\ninput(type='hidden', name='_csrf', value=_csrf)\n```\n\n**Note:** It is now possible to whitelist certain URLs. In other words you can\nspecify a list of routes that should bypass CSRF verification check.\n\n**Note 2:** To whitelist dynamic URLs use regular expression tests inside the\nCSRF middleware to see if `req.originalUrl` matches your desired pattern.\n\n### I am getting MongoDB Connection Error, how do I fix it?\nThat's a custom error message defined in `app.js` to indicate that there was a\nproblem connecting to MongoDB:\n\n```js\nmongoose.connection.on('error', (err) =\u003e {\n console.error(err);\n console.log('%s MongoDB connection error. Please make sure MongoDB is running.', chalk.red('✗'));\n process.exit();\n});\n```\nYou need to have a MongoDB server running before launching `app.js`. You can\ndownload MongoDB [here](http://mongodb.org/downloads), or install it via a package manager.\n\u003cimg src=\"http://dc942d419843af05523b-ff74ae13537a01be6cfec5927837dcfe.r14.cf1.rackcdn.com/wp-content/uploads/windows-8-50x50.jpg\" height=\"17\"\u003e\nWindows users, read [Install MongoDB on Windows](https://docs.mongodb.org/manual/tutorial/install-mongodb-on-windows/).\n\n**Tip:** If you are always connected to the internet, you could just use\n[MongoDB Atlas](https://www.mongodb.com/cloud/atlas) or [Compose](https://www.compose.io/) instead\nof downloading and installing MongoDB locally. You will only need to update database credentials\nin `.env` file.\n\n### I get an error when I deploy my app, why?\nChances are you haven't changed the *Database URI* in `.env`. If `MONGODB` is\nset to `localhost`, it will only work on your machine as long as MongoDB is\nrunning. When you deploy to Heroku, OpenShift or some other provider, you will not have MongoDB\nrunning on `localhost`. You need to create an account with [MongoDB Atlas](https://www.mongodb.com/cloud/atlas)\nor [Compose](https://www.compose.io/), then create a free tier database.\nSee [Deployment](#deployment) for more information on how to setup an account\nand a new database step-by-step with MongoDB Atlas.\n\n### Why Pug (Jade) instead of Handlebars?\nWhen 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.\n\n### Why do you have all routes defined in app.js?\nFor the sake of simplicity. While there might be a better approach,\nsuch as passing `app` context to each controller as outlined in this\n[blog](http://timstermatic.github.io/blog/2013/08/17/a-simple-mvc-framework-with-node-and-express/),\nI find such style to be confusing for beginners.\nIt took me a long time to grasp the concept of `exports` and `module.exports`,\nlet alone having a global `app` reference in other files.\nThat to me is a backward thinking.\nThe `app.js` is the \"heart of the app\", it should be the one referencing\nmodels, routes, controllers, etc.\nWhen 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))\nREST API server.\n\n### How do I switch SendGrid for another email delivery service, like Mailgun or SparkPost?\nInside the `nodemailer.createTransport` method arguments, simply change the service from `'Sendgrid'` to some other email service. Also, be sure to update both username and password below that. See the [list of all supported services](https://github.com/nodemailer/nodemailer-wellknown#supported-services) by Nodemailer.\n\nHow It Works (mini guides)\n--------------------------\n\nThis section is intended for giving you a detailed explanation about\nhow a particular functionality works. Maybe you are just curious about\nhow it works, or maybe you are lost and confused while reading the code,\nI hope it provides some guidance to you.\n\n### Custom HTML and CSS Design 101\n\n[HTML5 UP](http://html5up.net/) has many beautiful templates that you can download for free.\n\nWhen you download the ZIP file, it will come with *index.html*, *images*, *css* and *js* folders. So, how do you\nintegrate it with Hackathon Starter? Hackathon Starter uses Bootstrap CSS framework, but these templates do not.\nTrying to use both CSS files at the same time will likely result in undesired effects.\n\n**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.**\n\nLet's start from the beginning. For this example I will use [Escape Velocity](http://html5up.net/escape-velocity/) template:\n![Alt](http://html5up.net/uploads/images/escape-velocity.jpg)\n\n**Note:** For the sake of simplicity I will only consider `index.html`, and skip `left-sidebar.html`,\n`no-sidebar.html`, `right-sidebar.html`.\n\nMove 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 that would require manually changing every `img` reference. Grab the contents of `index.html` and paste it into [HTML To Pug](https://html-to-pug.com/).\n\n**Note:** Do not forget to update all the CSS and JS paths accordingly.\n\nCreate a new file `escape-velocity.pug` and paste the Pug markup in `views` folder.\nWhenever you see the code `res.render('account/login')` - that means it will search for `views/account/login.pug` file.\n\nLet's see how it looks. Create a new controller **escapeVelocity** inside `controllers/home.js`:\n\n```js\nexports.escapeVelocity = (req, res) =\u003e {\n res.render('escape-velocity', {\n title: 'Landing Page'\n });\n};\n```\n\nAnd then create a route in `app.js`. I placed it right after the index controller:\n```js\napp.get('/escape-velocity', homeController.escapeVelocity);\n```\n\nRestart the server (if you are not using **nodemon**), then you should see the new template at [http://localhost:8080/escape-velocity](http://localhost:8080/escape-velocity).\n\nI 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 Pug templates work: `layout.pug` - base template, `index.pug` - home page, `partials/header.pug` - Bootstrap navbar, `partials/footer.pug` - 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.pug`.\nThen, each page that changes, be it `index.pug`, `about.pug`, `contact.pug`\nwill be embedded in your new `layout.pug` via `block content`. Use existing templates as a reference.\n\nThis is a rather lengthy process, and templates you get from elsewhere,\nmight have yet another grid system. That's why I chose *Bootstrap* for the Hackathon Starter.\n Many people are already familiar with *Bootstrap*, plus it's easy to get started with it if you have never used *Bootstrap*.\n 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!\n\n\u003chr\u003e\n\n### How do flash messages work in this project?\nFlash messages allow you to display a message at the end of the request and access\nit on next request and only next request. For instance, on a failed login attempt, you would\ndisplay an alert with some error message, but as soon as you refresh that page or visit a different\npage and come back to the login page, that error message will be gone. It is only displayed once.\nThis project uses *express-flash* module for flash messages. And that\nmodule is built on top of *connect-flash*, which is what I used in\nthis project initially. With *express-flash* you don't have to\nexplicitly send a flash message to every view inside `res.render()`.\nAll flash messages are available in your views via `messages` object by default,\nthanks to *express-flash*.\n\nFlash messages have a two-step process. You use `req.flash('errors', { msg: 'Error messages goes here' }`\nto create a flash message in your controllers, and then display them in your views:\n```pug\nif messages.errors\n .alert.alert-danger.fade.in\n for error in messages.errors\n div= error.msg\n```\nIn the first step, `'errors'` is the name of a flash message, which should match the\nname of the property on `messages` object in your views. You place alert messages\ninside `if message.errors` because you don't want to show them flash messages are actually present.\nThe reason why you pass an error like `{ msg: 'Error messages goes here' }` instead\nof just a string - `'Error messages goes here'`, is for the sake of consistency.\nTo clarify that, *express-validator* module which is used for validating and sanitizing user's input,\nreturns all errors as an array of objects, where each object has a `msg` property with a message\nwhy an error has occurred. Here is a more general example of what express-validator returns when there are errors present:\n\n```js\n[\n { param: \"name\", msg: \"Name is required\", value: \"\u003creceived input\u003e\" },\n { param: \"email\", msg: \"A valid email is required\", value: \"\u003creceived input\u003e\" }\n]\n```\n\nTo keep consistent with that style, you should pass all flash messages\nas `{ msg: 'My flash message' }` instead of a string. Otherwise you will just see an alert box\nwithout an error message. That is because, in **partials/flash.pug** template it will try to output\n`error.msg` (i.e. `\"My flash message\".msg`), in other words it will try to call a `msg` method on a *String* object,\nwhich will return *undefined*. Everything I just mentioned about errors, also applies\nto \"info\" and \"success\" flash messages, and you could even create a new one yourself, such as:\n\n**Data Usage Controller (Example)**\n```\nreq.flash('warning', { msg: 'You have exceeded 90% of your data usage' });\n```\n\n**User Account Page (Example)**\n```pug\nif messages.warning\n .alert.alert-warning.fade.in\n for warning in messages.warning\n div= warning.msg\n```\n\n`partials/flash.pug` is a partial template that contains how flash messages\nare formatted. Previously, flash\nmessages were scattered throughout each view that used flash messages\n(contact, login, signup, profile), but now, thankfully it is uses a *DRY* approach.\n\nThe flash messages partial template is *included* in the `layout.pug`, along with footer and navigation.\n```pug\nbody\n include partials/header\n\n .container\n include partials/flash\n block content\n\n include partials/footer\n```\n\nIf you have any further questions about flash messages,\nplease feel free to open an issue and I will update this mini-guide accordingly,\nor send a pull request if you would like to include something that I missed.\n\n\u003chr\u003e\n\n### How do I create a new page?\nA more correct way to say this would be \"How do I create a new route?\" The main file `app.js` contains all the routes.\nEach route has a callback function associated with it. Sometimes you will see 3 or more arguments\nto routes. In cases like that, the first argument is still a URL string, while middle arguments\nare what's called middleware. Think of middleware as a door. If this door prevents you from\ncontinuing forward, you won't get to your callback function. One such example is a route that requires authentication.\n\n```js\napp.get('/account', passportConfig.isAuthenticated, userController.getAccount);\n```\n\nIt always goes from left to right. A user visits `/account` page. Then `isAuthenticated` middleware\nchecks if you are authenticated:\n\n```js\nexports.isAuthenticated = (req, res, next) =\u003e {\n if (req.isAuthenticated()) {\n return next();\n }\n res.redirect('/login');\n};\n```\n\nIf you are authenticated, you let this visitor pass through your \"door\" by calling `return next();`. It then proceeds to the\nnext 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.\n\n```js\nexports.getAccount = (req, res) =\u003e {\n res.render('account/profile', {\n title: 'Account Management'\n });\n};\n```\n\nExpress.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.\nIf you just want to display a page, then use `GET`, if you are submitting a form, sending a file then use `POST`.\n\nHere is a typical workflow for adding new routes to your application. Let's say we are building\na page that lists all books from database.\n\n**Step 1.** Start by defining a route.\n```js\napp.get('/books', bookController.getBooks);\n```\n\n---\n\n**Note:** As of Express 4.x you can define you routes like so:\n\n```js\napp.route('/books')\n .get(bookController.getBooks)\n .post(bookController.createBooks)\n .put(bookController.updateBooks)\n .delete(bookController.deleteBooks)\n```\n\nAnd here is how a route would look if it required an *authentication* and an *authorization* middleware:\n\n```js\napp.route('/api/twitter')\n .all(passportConfig.isAuthenticated)\n .all(passportConfig.isAuthorized)\n .get(apiController.getTwitter)\n .post(apiController.postTwitter)\n```\n\nUse whichever style that makes sense to you. Either one is acceptable. I really think that chaining HTTP verbs on\n`app.route` is very clean and elegant approach, but on the other hand I can no longer see all my routes at a glance\nwhen you have one route per line.\n\n**Step 2.** Create a new schema and a model `Book.js` inside the *models* directory.\n```js\nconst mongoose = require('mongoose');\n\nconst bookSchema = new mongoose.Schema({\n name: String\n});\n\nconst Book = mongoose.model('Book', bookSchema);\nmodule.exports = Book;\n```\n\n**Step 3.** Create a new controller file called `book.js` inside the *controllers* directory.\n```js\n/**\n * GET /books\n * List all books.\n */\nconst Book = require('../models/Book.js');\n\nexports.getBooks = (req, res) =\u003e {\n Book.find((err, docs) =\u003e {\n res.render('books', { books: docs });\n });\n};\n```\n\n**Step 4.** Import that controller in `app.js`.\n```js\nconst bookController = require('./controllers/book');\n```\n\n**Step 5.** Create `books.pug` template.\n```pug\nextends layout\n\nblock content\n .page-header\n h3 All Books\n\n ul\n for book in books\n li= book.name\n```\n\nThat's it! I will say that you could have combined Step 1, 2, 3 as following:\n\n```js\napp.get('/books',(req, res) =\u003e {\n Book.find((err, docs) =\u003e {\n res.render('books', { books: docs });\n });\n});\n```\n\nSure, 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.\nI mean, the whole point of this boilerplate project was to separate concerns, so you could\nwork with your teammates without running into *MERGE CONFLICTS*. Imagine you have 4 developers\nworking on a single `app.js`, I promise you it won't be fun resolving merge conflicts all the time.\nIf you are the only developer then it's fine. But as I said, once it gets up to a certain LoC size, it becomes\ndifficult to maintain everything in a single file.\n\nThat's all there is to it. Express.js is super simple to use.\nMost of the time you will be dealing with other APIs to do the real work:\n[Mongoose](http://mongoosejs.com/docs/guide.html) for querying database, socket.io for sending and receiving messages over websockets,\nsending emails via [Nodemailer](http://nodemailer.com/), form validation using [express-validator](https://github.com/ctavan/express-validator) library,\nparsing websites using [Cheerio](https://github.com/cheeriojs/cheerio), and etc.\n\n\u003chr\u003e\n\n### How do I use Socket.io with Hackathon Starter?\n[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.\nAnd as much as I'd like to add it to the project, I think it violates one of the main\nprinciples of the Hackathon Starter:\n\u003e When I started this project, my primary focus was on simplicity and ease of use.\n\u003e I also tried to make it as generic and reusable as possible to cover most use cases of\n\u003e hackathon web apps, **without being too specific**.\n\nWhen I need to use socket.io, I **really** need it, but most of the time - I don't. But more\nimportantly, websockets support is still experimental on most hosting providers. As of October 2013,\nHeroku supports websockets, but not until you opt-in by running this command:\n\n```js\nheroku labs:enable websockets -a myapp\n```\n\nAnd what if you are deploying to OpenShift? They do support websockets, but it is currently in a\npreview state. So, for OpenShift you would need to change the socket.io connect URI to the following:\n\n```js\nconst socket = io.connect('http://yoursite-namespace.rhcloud.com:8000');\n```\n\nWait, 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/)\nI wouldn't even know I had to use port 8000.\n\nI am really glad that Heroku and OpenShift at least\nhave a websockets support, because many other PaaS providers still do not support it.\nDue to the aforementioned issues with websockets, I cannot include socket.io as part of the Hackathon Starter. *For now...*\nIf you need to use socket.io in your app, please continue reading.\n\nFirst you need to install socket.io:\n```js\nnpm install socket.io --save\n```\n\nReplace `const app = express();` with the following code:\n\n```js\nconst app = express();\nconst server = require('http').Server(app);\nconst io = require('socket.io')(server);\n```\n\nI like to have the following code organization in `app.js` (from top to bottom): module dependencies,\nimport controllers, import configs, connect to database, express configuration, routes,\nstart the server, socket.io stuff. That way I always know where to look for things.\n\nAdd the following code at the end of `app.js`:\n\n```js\nio.on('connection', (socket) =\u003e {\n socket.emit('greet', { hello: 'Hey there browser!' });\n socket.on('respond', (data) =\u003e {\n console.log(data);\n });\n socket.on('disconnect', () =\u003e {\n console.log('Socket disconnected');\n });\n});\n```\n\nOne last thing left to change:\n```js\napp.listen(app.get('port'), () =\u003e {\n```\nto\n```js\nserver.listen(app.get('port'), () =\u003e {\n```\n\nAt this point we are done with the back-end.\n\nYou now have a choice - to include your JavaScript code in Pug templates or have all your client-side\nJavaScript in a separate file - in `main.js`. I will admit, when I first started out with Node.js and JavaScript in general,\nI placed all JavaScript code inside templates because I have access to template variables passed in from Express\nright then and there. It's the easiest thing you can do, but also the least efficient and harder to maintain. Since then I\nalmost never include inline JavaScript inside templates anymore.\n\nBut it's also understandable if you want take the easier road.\nMost of the time you don't even care about performance during hackathons, you just\nwant to [*\"get shit done\"*](https://www.startupvitamins.com/media/products/13/aaron_levie_poster_black.jpg) before the time runs out.\nWell, either way, use whichever approach makes more sense to you. At the end of the day,\nit's **what** you build that matters, not **how** you build it.\n\nIf you want to stick all your JavaScript inside templates, then in `layout.pug` -\nyour main template file, add this to `head` block.\n\n```pug\nscript(src='/socket.io/socket.io.js')\nscript.\n let socket = io.connect(window.location.href);\n socket.on('greet', function (data) {\n console.log(data);\n socket.emit('respond', { message: 'Hey there, server!' });\n });\n```\n\n**Note:** Notice the path of the `socket.io.js`, you don't actually\nhave to have `socket.io.js` file anywhere in your project; it will be generated\nautomatically at runtime.\n\nIf you want to have JavaScript code separate from templates, move that inline\nscript code into `main.js`, inside the `$(document).ready()` function:\n\n```js\n$(document).ready(function() {\n\n // Place JavaScript code here...\n let socket = io.connect(window.location.href);\n socket.on('greet', function (data) {\n console.log(data);\n socket.emit('respond', { message: 'Hello to you too, Mr.Server!' });\n });\n\n});\n```\n\nAnd we are done!\nCheatsheets\n-----------\n\n### \u003cimg src=\"https://frontendmasters.com/assets/es6-logo.png\" height=\"34\" align=\"top\"\u003e ES6 Cheatsheet\n\n#### Declarations\n\nDeclares a read-only named constant.\n\n```js\nconst name = 'yourName';\n```\n\nDeclares a block scope local variable.\n```js\nlet index = 0;\n```\n\n#### Template Strings\n\nUsing the **\\`${}\\`** syntax, strings can embed expressions.\n\n```js\nconst name = 'Oggy';\nconst age = 3;\n\nconsole.log(`My cat is named ${name} and is ${age} years old.`);\n```\n\n#### Modules\n\nTo import functions, objects or primitives exported from an external module. These are the most common types of importing.\n\n```js\nconst name = require('module-name');\n```\n\n```js\nconst { foo, bar } = require('module-name');\n```\n\nTo export functions, objects or primitives from a given file or module.\n\n```js\nmodule.exports = { myFunction };\n```\n\n```js\nmodule.exports.name = 'yourName';\n```\n\n```js\nmodule.exports = myFunctionOrClass;\n```\n\n#### Spread Operator\n\nThe spread operator allows an expression to be expanded in places where multiple arguments (for function calls) or multiple elements (for array literals) are expected.\n\n```js\nmyFunction(...iterableObject);\n```\n```jsx\n\u003cChildComponent {...this.props} /\u003e\n```\n\n#### Promises\n\nA Promise is used in asynchronous computations to represent an operation that hasn't completed yet, but is expected in the future.\n\n```js\nvar p = new Promise(function(resolve, reject) { });\n```\n\nThe `catch()` method returns a Promise and deals with rejected cases only.\n\n```js\np.catch(function(reason) { /* handle rejection */ });\n```\n\nThe `then()` method returns a Promise. It takes 2 arguments: callback for the success \u0026 failure cases.\n\n```js\np.then(function(value) { /* handle fulfillment */ }, function(reason) { /* handle rejection */ });\n```\n\nThe `Promise.all(iterable)` method returns a promise that resolves when all of the promises in the iterable argument have resolved, or rejects with the reason of the first passed promise that rejects.\n\n```js\nPromise.all([p1, p2, p3]).then(function(values) { console.log(values) });\n```\n\n#### Arrow Functions\n\nArrow function expression. Shorter syntax \u0026 lexically binds the `this` value. Arrow functions are anonymous.\n\n```js\nsingleParam =\u003e { statements }\n```\n```js\n() =\u003e { statements }\n```\n```js\n(param1, param2) =\u003e expression\n```\n```js\nconst arr = [1, 2, 3, 4, 5];\nconst squares = arr.map(x =\u003e x * x);\n```\n\n#### Classes\n\nThe class declaration creates a new class using prototype-based inheritance.\n\n```js\nclass Person {\n constructor(name, age, gender) {\n this.name = name;\n this.age = age;\n this.gender = gender;\n }\n\n incrementAge() {\n this.age++;\n }\n}\n```\n\n:gift: **Credits**: [DuckDuckGo](https://duckduckgo.com/?q=es6+cheatsheet\u0026ia=cheatsheet\u0026iax=1) and [@DrkSephy](https://github.com/DrkSephy/es6-cheatsheet).\n\n:top: \u003csub\u003e[**back to top**](#table-of-contents)\u003c/sub\u003e\n\n### \u003cimg src=\"http://i.stack.imgur.com/Mmww2.png\" height=\"34\" align=\"top\"\u003e JavaScript Date Cheatsheet\n\n#### Unix Timestamp (seconds)\n\n```js\nMath.floor(Date.now() / 1000);\n```\n\n```MomentJS\nmoment().unix();\n```\n\n#### Add 30 minutes to a Date object\n\n```js\nvar now = new Date();\nnow.setMinutes(now.getMinutes() + 30);\n```\n\n```MomentJS\nmoment().add(30, 'minutes');\n```\n\n#### Date Formatting\n\n```js\n// DD-MM-YYYY\nvar now = new Date();\n\nvar DD = now.getDate();\nvar MM = now.getMonth() + 1;\nvar YYYY = now.getFullYear();\n\nif (DD \u003c 10) {\n DD = '0' + DD;\n}\n\nif (MM \u003c 10) {\n MM = '0' + MM;\n}\n\nconsole.log(MM + '-' + DD + '-' + YYYY); // 03-30-2016\n```\n```MomentJS\nconsole.log(moment(new Date(), 'MM-DD-YYYY'));\n```\n\n```js\n// hh:mm (12 hour time with am/pm)\nvar now = new Date();\nvar hours = now.getHours();\nvar minutes = now.getMinutes();\nvar amPm = hours \u003e= 12 ? 'pm' : 'am';\n\nhours = hours % 12;\nhours = hours ? hours : 12;\nminutes = minutes \u003c 10 ? '0' + minutes : minutes;\n\nconsole.log(hours + ':' + minutes + ' ' + amPm); // 1:43 am\n```\n\n```MomentJS\nconsole.log(moment(new Date(), 'hh:mm A'));\n```\n\n#### Next week Date object\n\n```js\nvar today = new Date();\nvar nextWeek = new Date(today.getTime() + 7 * 24 * 60 * 60 * 1000);\n```\n\n```MomentJS\nmoment().add(7, 'days');\n```\n\n#### Yesterday Date object\n\n```js\nvar today = new Date();\nvar yesterday = date.setDate(date.getDate() - 1);\n```\n\n```MomentJS\nmoment().add(-1, 'days');\n```\n\n:top: \u003csub\u003e[**back to top**](#table-of-contents)\u003c/sub\u003e\n\n### Mongoose Cheatsheet\n\n#### Find all users:\n```js\nUser.find((err, users) =\u003e {\n console.log(users);\n});\n```\n\n#### Find a user by email:\n```js\nlet userEmail = 'example@gmail.com';\nUser.findOne({ email: userEmail }, (err, user) =\u003e {\n console.log(user);\n});\n```\n\n#### Find 5 most recent user accounts:\n```js\nUser\n .find()\n .sort({ _id: -1 })\n .limit(5)\n .exec((err, users) =\u003e {\n console.log(users);\n });\n```\n\n#### Get total count of a field from all documents:\nLet's suppose that each user has a `votes` field and you would like to count\nthe total number of votes in your database across all users. One very\ninefficient way would be to loop through each document and manually accumulate\nthe count. Or you could use [MongoDB Aggregation Framework](https://docs.mongodb.org/manual/core/aggregation-introduction/) instead:\n\n```js\nUser.aggregate({ $group: { _id: null, total: { $sum: '$votes' } } }, (err, votesCount) =\u003e {\n console.log(votesCount.total);\n});\n```\n:top: \u003csub\u003e[**back to top**](#table-of-contents)\u003c/sub\u003e\n\nDocker\n----------\n\nYou will need docker and docker-compose installed to build the application.\n\n- [Docker installation](https://docs.docker.com/engine/installation/)\n\n- [Common problems setting up docker](https://docs.docker.com/toolbox/faqs/troubleshoot/)\n\nAfter installing docker, start the application with the following commands :\n\n```\n# To build the project for the first time or when you add dependencies\ndocker-compose build web\n\n# To start the application (or to restart after making changes to the source code)\ndocker-compose up web\n\n```\n\nTo view the app, find your docker ip address + port 8080 ( this will typically be http://localhost:8080/ ). To use a port other than 8080, you would need to modify the port in app.js, Dockerfile and docker-compose.yml.\n\n\nDeployment\n----------\n\nOnce you are ready to deploy your app, you will need to create an account with\na cloud platform to host it. These are not the only choices, but they are my top\npicks. From my experience, **Heroku** is the easiest to get started with, it will\nautomatically restart your Node.js process when it crashes, zero-downtime\ndeployments and custom domain support on free accounts. Additionally, you can\ncreate an account with **MongoDB Atlas** and then pick one of the *4* providers below.\nAgain, there are plenty of other choices and you are not limited to just the ones\nlisted below.\n\n### 1-Step Deployment with Heroku\n\n\u003cimg src=\"https://upload.wikimedia.org/wikipedia/en/a/a9/Heroku_logo.png\" width=\"200\"\u003e\n\n- Download and install [Heroku Toolbelt](https://toolbelt.heroku.com/)\n- In terminal, run `heroku login` and enter your Heroku credentials\n- From *your app* directory run `heroku create`\n- Run `heroku addons:create mongolab`. This will set up the mLab add-on and configure the `MONGODB_URI` environment variable in your Heroku app for you.\n- Lastly, do `git push heroku master`. Done!\n\n**Note:** To install Heroku add-ons your account must be verified.\n\n---\n\n\u003cimg src=\"https://www.mongodb.com/assets/images/global/MongoDB_Logo_Dark.svg\" width=\"200\"\u003e\n\n- Go to [https://www.mongodb.com/cloud/atlas](https://www.mongodb.com/cloud/atlas)\n- Click the green **Get started free** button\n- Fill in your information then hit **Get started free**\n- You will be redirected to Create New Cluster page.\n- Select a **Cloud Provider and Region** (such as AWS and a free tier region)\n- Select cluster Tier to **Free Shared Clusters**\n- Give Cluster a name (default: Cluster0)\n- Click on green **:zap:Create Cluster button**\n- Now, to access your database you need to create a DB user. To create a new MongoDB user, from the **Clusters view**, select the **Security tab**\n- Under the **MongoDB Users** tab, click on **+Add New User**\n- Fill in a username and password and give it either **Atlas Admin** User Privilege\n- Next, you will need to create an IP address whitelist and obtain the connection URI. In the Clusters view, under the cluster details (i.e. SANDBOX - Cluster0), click on the **CONNECT** button.\n- Under section **(1) Check the IP Whitelist**, click on **ALLOW ACCESS FROM ANYWHERE**. The form will add a field with `0.0.0.0/0`. Click **SAVE** to save the `0.0.0.0/0` whitelist.\n- Under section **(2) Choose a connection method**, click on **Connect Your Application**\n- In the new screen, click on **Standard connection string (3.4+ driver)**. __*WARNING*__: Do not pick 3.6+ since there Express Session currently has a compatibility issue with it.\n- Finally, copy the URI connection string and replace the URI in MONGODB_URI of `.env.example` with this URI string. Make sure to replace the \u003cPASSWORD\u003e with the db User password that you created under the Security tab.\n- Note that after some of the steps in the Atlas UI, you may see a banner stating `We are deploying your changes`. You will need to wait for the deployment to finish before using the DB in your application.\n\n\n\n**Note:** As an alternative to MongDB Atlas, there is also [Compose](https://www.compose.io/).\n\n\u003cimg src=\"http://www.opencloudconf.com/images/openshift_logo.png\" width=\"200\"\u003e\n**NOTE** *These instructions might be out of date due to changes in OpenShift. Heroku is currently a good free alternative. If you the new process, please feel free to help us update this page*\n\n- First, install this Ruby gem: `sudo gem install rhc` :gem:\n- Run `rhc login` and enter your OpenShift credentials\n- From your app directory run `rhc app create MyApp nodejs-0.10`\n - **Note:** *MyApp* is the name of your app (no spaces)\n- Once that is done, you will be provided with **URL**, **SSH** and **Git Remote** links\n- Visit provided **URL** and you should see the *Welcome to your Node.js application on OpenShift* page\n- Copy and and paste **Git Remote** into `git remote add openshift YOUR_GIT_REMOTE`\n- Before you push your app, you need to do a few modifications to your code\n\nAdd these two lines to `app.js`, just place them anywhere before `app.listen()`:\n```js\nvar IP_ADDRESS = process.env.OPENSHIFT_NODEJS_IP || '127.0.0.1';\nvar PORT = process.env.OPENSHIFT_NODEJS_PORT || 8080;\n```\n\nThen change `app.listen()` to:\n```js\napp.listen(PORT, IP_ADDRESS,() =\u003e {\n console.log(`Express server listening on port ${PORT} in ${app.settings.env} mode`);\n});\n```\nAdd 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.\n\n```js\n\"main\": \"app.js\",\n\"scripts\": {\n \"start\": \"supervisor app.js\"\n},\n```\n\n- Finally, you can now push your code to OpenShift by running `git push -f openshift master`\n - **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. **Do not** run `git pull` as it will create unnecessary merge conflicts.\n- And you are done!\n\n\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/f/ff/Windows_Azure_logo.png\" width=\"200\"\u003e\n**NOTE** *Beyound the initial 12 month trial of Azure, the platform does not seem to offer a free tier for hosting NodeJS apps. If you are looking for a free tier service to host your app, Heroku might be a better choice at this point*\n\n- Login to [Windows Azure Management Portal](https://manage.windowsazure.com/)\n- Click the **+ NEW** button on the bottom left of the portal\n- Click **COMPUTE**, then **WEB APP**, then **QUICK CREATE**\n- Enter a name for **URL** and select the datacenter **REGION** for your web site\n- Click on **CREATE WEB APP** button\n- Once the web site status changes to *Running*, click on the name of the web site to access the Dashboard\n- At the bottom right of the Quickstart page, select **Set up a deployment from source control**\n- Select **Local Git repository** from the list, and then click the arrow\n- To enable Git publishing, Azure will ask you to create a user name and password\n- Once the Git repository is ready, you will be presented with a **GIT URL**\n- Inside your *Hackathon Starter* directory, run `git remote add azure [Azure Git URL]`\n- To push your changes simply run `git push azure master`\n - **Note:** *You will be prompted for the password you created earlier*\n- On **Deployments** tab of your Windows Azure Web App, you will see the deployment history\n\n------\n\n\n# IBM Bluemix Cloud Platform\n**NOTE** *At this point it appears that Bluemix's free tier to host NodeJS apps is limited to 30 days. If you are looking for a free tier service to host your app, Heroku might be a better choice at this point*\n\n1. Create a Bluemix Account\n\n [Sign up](https://console.ng.bluemix.net/registration/?target=%2Fdashboard%2Fapps) for Bluemix, or use an existing account.\n\n1. Download and install the [Cloud Foundry CLI](https://github.com/cloudfoundry/cli) to push your applications to Bluemix.\n\n1. Create a `manifest.yml` file in the root of your application.\n ```\n applications:\n - name: \u003cyour-app-name\u003e\n host: \u003cyour-app-host\u003e\n memory: 128M\n services:\n - myMongo-db-name\n ```\n\n The host you use will determinate your application url initially, e.g. `\u003chost\u003e.mybluemix.net`.\n The service name 'myMongo-db-name' is a declaration of your MongoDB service. If you are using other services like Watson for example, then you would declare them the same way.\n\n1. Connect and login to Bluemix via the Cloud-foundry CLI\n ```\n $ cf login -a https://api.ng.bluemix.net\n ```\n\n1. Create a [MongoDB service](https://www.ng.bluemix.net/docs/#services/MongoDB/index.html#MongoDB)\n ```\n $ cf create-service mongodb 100 [your-service-name]\n ```\n **Note:** this is a free and experiment verion of MongoDB instance.\n Use the MongoDB by Compose instance for production applications:\n ```\n $ cf create-service compose-for-mongodb Standard [your-service-name]'\n ```\n\n\n1. Push the application\n\n ```\n $ cf push\n ```\n ```\n $ cf env \u003cyour-app-name \u003e\n (To view the *environment variables* created for your application)\n\n ```\n\n**Done**, now go to the staging domain(`\u003chost\u003e.mybluemix.net`.) and see your app running.\n\n[Cloud Foundry Commands](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html)\n[More Bluemix samples](https://ibm-bluemix.github.io/)\n[Simple ToDo app in a programming language of your choice](https://github.com/IBM-Bluemix/todo-apps)\n\n\n\n## IBM Watson\nBe sure to check out the full list of Watson services to forwarder enhance your application functionality with a little effort. Watson services are easy to get going, it is simply an RESTful API call. Here is an example of a [Watson Toner Analyzer](https://tone-analyzer-demo.mybluemix.net/) to understand the emotional context of a piece of text that you send to Watson.\n\n\n\n### Watson catalog of services\n\n**\u003cimg src=\"https://wbi.mybluemix.net/icons/conversation.svg?version=2\" width=\"25\"\u003e [Conversation](https://www.ibm.com/watson/services/conversation/)** - \tQuickly build and deploy chatbots and virtual agents across a variety of channels, including mobile devices, messaging platforms, and even robots.\n\n**\u003cimg src=\"https://wbi.mybluemix.net/icons/discovery.svg\" width=\"25\"\u003e [Discovery](https://www.ibm.com/watson/services/discovery/)** - Unlock hidden value in data to find answers, monitor trends and surface patterns with the world’s most advanced cloud-native insight engine.\n\n**\u003cimg src=\"https://wbi.mybluemix.net/icons/language-translator.svg?version=4\" width=\"20\" width=\"25\"\u003e [Language Translator](https://www.ibm.com/watson/services/language-translator/)** - Translate text from one language to another.\n\n**\u003cimg src=\"https://wbi.mybluemix.net/icons/natural-language-classifier.svg?version=2\" width=\"25\"\u003e [Natural Language Classifier](https://www.ibm.com/watson/services/natural-language-classifier/)** - Interpret and classify natural language with confidence.\n\n**\u003cimg src=\"https://wbi.mybluemix.net/icons/natural-language-understanding.svg?version=2\" width=\"25\"\u003e [Natural Language Understanding](https://www.ibm.com/watson/services/natural-language-understanding/)** - Analyze text to extract meta-data from content such as concepts, entities, keywords and more.\n\n**\u003cimg src=\"https://wbi.mybluemix.net/icons/personality-insights.svg?version=2\" width=\"25\"\u003e [Personality Insights](https://www.ibm.com/watson/services/personality-insights/)** - Predict personality characteristics, needs and values through written text.\n\n**\u003cimg src=\"https://wbi.mybluemix.net/icons/speech-to-text.svg?version=2\" width=\"25\"\u003e [Speech to Text](https://www.ibm.com/watson/services/speech-to-text/)** - Convert audio and voice into written text for quick understanding of content.\n\n**\u003cimg src=\"https://wbi.mybluemix.net/icons/text-to-speech.svg?version=2\" width=\"25\"\u003e [Text to Speech](https://www.ibm.com/watson/services/text-to-speech/)** - Convert written text into natural sounding audio in a variety of languages and voices.\n\n**\u003cimg src=\"https://wbi.mybluemix.net/icons/tone-analyzer.svg?version=2\" width=\"25\"\u003e [Tone Analyzer](https://www.ibm.com/watson/services/tone-analyzer/)** - Understand emotions, social tendencies and perceived writing style.\n\n**\u003cimg src=\"https://kpprod1.alchemyapi.com/images/vis_rec.svg\" width=\"25\"\u003e [Visual Recognition](https://www.ibm.com/watson/services/visual-recognition/)** - Tag, classify and search visual content using machine learning.\n\n\n\n[Click here](https://www.ibm.com/watson/developercloud/services-catalog.html) for live demos of each Watson service.\n\n\n---\n\n\u003cimg src=\"https://avatars2.githubusercontent.com/u/2810941?v=3\u0026s=64\" width=\"64\" align=\"left\"\u003e\n\n# Google Cloud Platform\n\n- [Download and install Node.js](https://nodejs.org/)\n- [Select or create](https://console.cloud.google.com/project) a Google Cloud Platform Console project\n- [Enable billing](https://support.google.com/cloud/answer/6293499#enable-billing) for your project (there's a $300 free trial)\n- Install and initialize the [Google Cloud SDK](https://cloud.google.com/sdk/docs/quickstarts)\n- Create an `app.yaml` file at the root of your `hackathon-starter` folder with the following contents:\n\n ```yaml\n runtime: nodejs\n env: flex\n manual_scaling:\n instances: 1\n ```\n- Make sure you've set `MONGODB_URI` in `.env.example`\n- Run the following command to deploy the `hackathon-starter` app:\n\n ```bash\n gcloud app deploy\n ```\n- [Monitor your deployed app](https://console.cloud.google.com/appengine) in the Cloud Console\n- [View the logs](https://console.cloud.google.com/logs/viewer) for your app in the Cloud Console\n\nChangelog\n---------\n\nYou can find the changelog for the project in: [CHANGELOG.md](https://github.com/sahat/hackathon-starter/blob/master/CHANGELOG.md)\n\n\nContributing\n------------\n\nIf something is unclear, confusing, or needs to be refactored, please let me know.\nPull requests are always welcome, but due to the opinionated nature of this\nproject, I cannot accept every pull request. Please open an issue before\nsubmitting a pull request. This project uses\n[Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) with a\nfew minor exceptions. If you are submitting a pull request that involves\nPug templates, please make sure you are using *spaces*, not tabs.\n\nLicense\n-------\n\nThe MIT License (MIT)\n\nCopyright (c) 2014-2019 Sahat Yalkabov\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphalbert%2Fhackathon-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphalbert%2Fhackathon-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphalbert%2Fhackathon-starter/lists"}