hirako2000/hackathon-board

node.js based webapp to manage Hackathon events

Table of Contents

• Demo
• Features
• Prerequisites
• Setup
• Obtaining API Keys
• FAQ
• Contributing
• License

Demo

See a live demo here

The demo instance often goes to sleep after inactivity, cilck and wait about a minute for it to awake.

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
• Create hack
  • Title
  • picture
  • description
  • category
  • season
• List hacks
• Search
  • By title
  • category
  • season
• Join hack
• Add comments
• List prizes
  • Name
  • picture
  • description
• Rules page
• User profile
  • Gravatar
  • Profile Details
  • Change Password
  • Forgot Password
  • Reset Password
  • Link multiple OAuth strategies to one account
  • Delete Account
• CSRF protection
• Admin
  • Add/edit categories
  • Add/edit seasons
  • Add/Edit prize
  • Edit rules
  • Nominate hack
• Beautifier

Prerequisites

• MongoDB
• Node.js

Setup

# Get the latest code
$ git clone https://github.com/hirako2000/hackathon-board.git myproject
$ cd myproject
$ git remote rm origin

# Install NPM dependencies
$ npm install

$ node app.js

Obtaining API Keys

To use any of the included APIs or OAuth authentication 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.

I have included dummy keys and passwords from Hackathon Starter . But don't forget to update them with your credentials when you are ready to deploy an app. https://github.com/sahat/hackathon-starter

FAQ

Admin user? Starting with 1.0.2, the first user to signup with email/passowrd becomes admin. Admin users can make other users admin in the admin users page.

Anything for the admin to setup

• Yes, as admin, create at least one Season, one category. (required or no hack can be create by users)
• Then Also fill the Rules page, and add some prize entry.

That's pretty much all needed to get going, from there users can create their own hacks.

Why can I not add new locations?

• Add location in the source code. It's fairly easy to add as many as you like. I never got to implement a CRUD for these.

Contributing

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. If you are submitting a pull request that involves Jade templates, please make sure you are using spaces, not tabs.

License

The MIT License (MIT)