Hackathon Starter
=======================

NOTE Hackathon-starter is primarily distributed using git clone of its repo at https://github.com/sahat/hackathon-starter. This npm package consists of a script that does that for you. Alternatively you can go to the hackathon-starter repo and follow the installation instructions there.

Hackathon Starter is a boilerplate for Node.js web applications.

If you have attended any hackathons in the past, then you know how much time it takes to
get a project started: decide on what to build, pick a programming language, pick a web framework,
pick a CSS framework. A while later, you might have an initial project up on GitHub and only then
can other team members start contributing. Or how about doing something as simple as Sign in with Facebook
authentication? You can spend hours on it if you are not familiar with how OAuth 2.0 works.

Features
--------

- Local Authentication using Email and Password
- OAuth 1.0a Authentication via Twitter
- OAuth 2.0 Authentication via Facebook, Google, GitHub, LinkedIn, Instagram
- Flash notifications
- MVC Project Structure
- Node.js clusters support
- Sass stylesheets (auto-compiled via middleware)
- Bootstrap 3 + Extra Themes
- Contact Form (powered by Mailgun, Sendgrid or Mandrill)
- Account Management
- Gravatar
- Profile Details
- Change Password
- Forgot Password
- Reset Password
- Link multiple OAuth strategies to one account
- Delete Account
- CSRF protection
- API Examples: Facebook, Foursquare, Last.fm, Tumblr, Twitter, Stripe, LinkedIn and more.

Prerequisites
-------------

- MongoDB
- Node.js 8.0+
- Command Line Tools
-  Mac OS X: Xcode (or OS X 10.9+: xcode-select --install)
-  Windows: Visual Studio OR Visaul Studio Code + Windows Subsystem for Linux - Ubuntu
-  Ubuntu /  Linux Mint: sudo apt-get install build-essential
-  Fedora: sudo dnf groupinstall "Development Tools"
-  OpenSUSE: sudo zypper install --type pattern devel_basis


Getting Started
---------------

The easiest way to get started is to clone the hackathon-starter repo :

``bash


Get the latest snapshot

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

Change directory

cd myproject

Install NPM dependencies

npm install

Then simply start your app

node app.js
`

Alternatively, this npm package can be installed globally, and consists of a script that does the cloning of the hackathon-starter project for you.

Install this npm package by installing it globally using:
`bash
#
npm install -g hackathon-starter
`

If you get a permission error during the installation, retry with sudo permission in bash. If you are using Windows CMD, retry using a CMD with Administrator privileges:
`bash
#
sudo npm install -g hackathon-starter
`

After the installation, you can just start a new hackathon project named myproject in the folder myproject by:
`bash
#
hackathon-starter myproject
``