• As an authenticated user, I can keep my polls and come back later to access them.
• As an authenticated user, I can share my polls with my friends.
• As an authenticated user, I can see the aggregate results of my polls.
• As an authenticated user, I can delete polls that I decide I don't want anymore.
• As an authenticated user, I can create a poll with any number of possible items.
• As an unauthenticated or authenticated user, I can see and vote on everyone's polls.
• As an unauthenticated or authenticated user, I can see the results of polls in chart form. (using Chart.js)
• As an authenticated user, if I don't like the options on a poll, I can create a new option.

• Local Authentication using Email and Password
• passport Authentication via Twitter, GitHub and can add many more with passport.js
• Node.js
• Express
• Flash notifications
• BDD Project Structure
• mongoose
• ejs
• nodemon
• morgan
• Gulp
• Mocha
• Bootstrap 3
• Chart.js

• MongoDB
• Node.js
• mLab Database-as-a-Service
• Finding your database connection info
• Set value of process.env in (How to set)
  • config/database.js process.env.MONGO_VOTING
  • config/auth.js
    • process.env.TWITTER_KEY
    • process.env.TWITTER_SECRET
    • process.env.TWITTER_URL
    • process.env.GITHUB_ID
    • process.env.GITHUB_SECRET
    • process.env.GITHUB_URL
• If you are deploying on Heroku, don't forget to set your config vars (How to set)

Now you are done, Ready to go!

The easiest way to get started is to clone the repository:

# Get the latest snapshot
git clone https://github.com/extwiii/Votapp-Node.js.git

# Change directory
cd Votapp-Nodejs

# Install NPM dependencies
npm install

# Then simply start your app
node server.js

# Or, You can use gulp, it will also run mocha for test
gulp

Note: I highly recommend installing Nodemon. It watches for any changes in your node.js app and automatically restarts the server. Once installed, instead of node server.js use nodemon. It will save you a lot of time in the long run, because you won't need to manually restart the server each time you make a small change in code. To install, run sudo npm install -g nodemon.

To use any of the included APIs(twitter, github and many more) methods, you will need to obtain appropriate credentials: Client ID, Client Secret, API Key, or Username & Password. You will need to go through each provider to generate new credentials.

Once you are ready to deploy your app, you will need to create an account with a cloud platform to host it. These are not the only choices, but they are my top picks. From my experience, Heroku is the easiest to get started with, it will automatically restart your Node.js process when it crashes, zero-downtime deployments and custom domain support on free accounts. Additionally, you can create an account with mLab and then pick one of the 4 providers below. Again, there are plenty of other choices and you are not limited to just the ones listed below.

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

Note: As an alternative to mLab, there is also Compose.

• Login to Windows Azure Management Portal
• Click the + NEW button on the bottom left of the portal
• Click COMPUTE, then WEB APP, then QUICK CREATE
• Enter a name for URL and select the datacenter REGION for your web site
• Click on CREATE WEB APP button
• Once the web site status changes to Running, click on the name of the web site to access the Dashboard
• At the bottom right of the Quickstart page, select Set up a deployment from source control
• Select Local Git repository from the list, and then click the arrow
• To enable Git publishing, Azure will ask you to create a user name and password
• Once the Git repository is ready, you will be presented with a GIT URL
• Inside your Hackathon Starter directory, run git remote add azure [Azure Git URL]
• To push your changes simply run git push azure master
• Note: You will be prompted for the password you created earlier
• On Deployments tab of your Windows Azure Web App, you will see the deployment history

• Go to Codename: Bluemix to signup for the free trial, or login with your IBM id
• Install Cloud Foundry CLI
• Navigate to your hackathon-starter directory and then run cf push [your-app-name] -m 512m command to deploy the application
• Note: You must specify a unique application name in place of [your-app-name]
• Run cf create-service mongodb 100 [your-service-name] to create a MongoDB service
• Run cf bind-service [your-app-name] [your-service-name] to associate your application with a service created above
• Run cf files [your-app-name] logs/env.log to see the *environment variables created for MongoDB.
• Copy the MongoDB URI that should look something like the following: mongodb://68638358-a3c6-42a1-bae9-645b607d55e8:[email protected]:10123/db
• Then set it as an environment variable for your application by running cf set-env [your-app-name] MONGODB_URI [your-mongodb-uri]
• Run cf restart [your-app-name] for the changes to take effect.
• Visit your starter app at http://[your-app-name].ng.bluemix.net
• Done!

Note: Alternative directions, including how to setup the project with a DevOps pipeline are available at http://ibm.biz/hackstart. A longer version of these instructions with screenshots is available at http://ibm.biz/hackstart2. Also, be sure to check out the Jump-start your hackathon efforts with DevOps Services and Bluemix video.

• Download and install Node.js

• Select or create a Google Cloud Platform Console project

• Enable billing for your project (there's a $300 free trial)

• Install and initialize the Google Cloud SDK

• Create an app.yaml file at the root of your hackathon-starter folder with the following contents:

  runtime: nodejs
  vm: true
  manual_scaling:
    instances: 1

• Make sure you've set MONGODB_URI or MONGOLAB_URI in .env.example

• Run the following command to deploy the hackathon-starter app:

  gcloud app deploy

• Monitor your deployed app in the Cloud Console

• View the logs for your app in the Cloud Console

• First version of votapp

If something is unclear, confusing, or needs to be refactored, please let me know. Pull requests are always welcome, but due to the opinionated nature of this project, I cannot accept every pull request. Please open an issue before submitting a pull request. This project uses Airbnb JavaScript Style Guide with a few minor exceptions.

The MIT License (MIT)

Copyright (c) 2017 Bilal Cagiran

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.