Giter Club home page Giter Club logo

hackathon_organizer's Introduction

*NOTE: The application is no longer maintaned. But it is stable to use. Use at your own risk.

If you are interested into taking over the onwership, just get in touch with me.**

Hackathon Organizer Code Climate Travis Coverage Status

Small rails app that receives Hackathon ideas and also to subscribe the developers into it.

Grab the lastest release at: https://github.com/rafaelbiriba/hackathon_organizer/releases

If you have any question about how to use the application, just reach me out!

Prerequisites

  • Google account for the login/access to the website
  • Create a project at Google to get the GOOGLE_OAUTH_ID and GOOGLE_OAUTH_SECRET. (Details below)

Creating the Google OAUTH Credentials

  • Access https://console.developers.google.com/apis/ and create your app there.
  • Go to Create credentials > Oauth Client ID > Web Application
  • Fill the information of your website url and your website oauth callback (Examples: http://example.com and http://example.com/auth/google_oauth2/callback)
  • Extra step: Don't forget to add HTTP and HTTPS urls if this is your scenario.

Installation

Detailed documentation comming soon.

Installation for a normal Rails app with Postgresql. (Recommended: Heroku with Postgresql plugin)

After deployment:

  • Create the settings for production. (check config/settings/production.yml.example for the configuration file example)
  • Setup the database yml for production Postgresql. (check config/database.yml.production)
  • Run rake db:create and rake db:schema:load (to load the schema file into the database)
  • Run rake users:give_superuser[[email protected]] to give the superuser admin to [email protected].

TODO/Backlog List

  • [HIGH] Finish the test coverage
  • [HIGH] Refactor the controller (specially the projects)
  • [HIGH] Add proper documentation
  • [HIGH] Rename Subscribers to Workers, because is kind confusing
  • [MID] Add kubernetes or ansible or [type-name-here] to automate the deploy (Today only supports Heroku)
  • [MID] Add Edition concept (so we can have the history from previous hackathon)
  • [MID] With the history, introduce a way to clone or copy old ideas into the running hackathon.
  • [LOW] Add mentions at comments
  • [LOW] Add notifications via email
  • [LOW] Add my profile page (customize name, picture, and other preferences)
  • [LOW] Support for Facebook login
  • [LOW] Add a bug report feature (or at least a link for a github page)
  • [LOW] Move this todo list to github issues

Screenshots

Detailed documentation comming soon.

Project list view

Project show view

Contributing

First of all, thank you for wanting to help!

  1. Fork it.
  2. Create a feature branch - git checkout -b more_magic
  3. Add tests and make your changes
  4. Check if tests are ok - rake spec
  5. Commit changes - git commit -am "Added more magic"
  6. Push to Github - git push origin more_magic
  7. Send a pull request! ❤️

Development Notes

Switching Users

Only for development environment, you can easily switch users using ?user=<id> at the url. This will switch the logged user on-the-fly. (Example: http://localhost:3000/projects?user=3)

Populating the Database

The file seed.rb is responsible to populate the database with a lot of dummy data. You can use this to create an functional application and test things around. You can run it using rake db:seed

hackathon_organizer's People

Contributors

dependabot[bot] avatar rafaelbiriba avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.