Giter VIP home page Giter VIP logo

hackweek's Introduction

Build Status Coverage Status Code Climate

HackWeek

A tool to nurture hack ideas into projects and then collaborate on them. It's used during SUSEs hackweek, a week where SUSE engineers can experiment without limits and get their opportunity to innovate, collaborate across teams, and learn.

Features

  • Admins can add hackweeks
  • Users create ideas for a hackweek
  • Users can like and comment on ideas
  • Users can join ideas turning them into projects
  • Users can supplement projects with files, links, agenda items and "needs"
  • Users can supplement themselves with "haves"
  • Ideas/Projects "needs" are matched to Users "haves"
  • Admins can rate project results

Requirements

Sphinx (searchd) must be installed. No need to configure and launch it separately, everything will be taken care of with rake ts:regenerate.

Hack it

As our project involves somewhat complicated setup (MySQL and Shpinx search) for a development environment, we have created docker and vagrant files to get you up and running.

Docker

  1. Since we mount the hackweek repository into our container we need to map your local user id to the one of the container user. To do that copy the docker-compose.override.yml file and enter your user id (id -u) as CONTAINER_USERID.
cp docker-compose.override.yml.example docker-compose.override.yml
vi docker-compose.override.yml
  1. Set up the development environment:
docker-compose run --rm hackweek bundle exec rake dev:bootstrap
  1. Start the development environment:
docker-compose up --build

Vagrant

  1. Install VirtualBox and vagrant
  2. Install vagrant-exec plugin:
vagrant plugin install vagrant-exec
  1. Start our openSUSE 42.3 based virtual machine with vagrant
vagrant up
  1. Launch the application
vagrant exec foreman start
  1. Access the appliaction as usual
xdg-open http://localhost:3000
  1. Start hacking
  2. Test your changes
vagrant exec rspec
  1. Send pull request
  2. $UCCE$$

Remote connection to the virtual machine is available with vagrant ssh. You can run single-shot remote commands like vagrant exec rake db:migrate. If you are done hacking you can stop the virtual machine with vagrant halt and remove all traces of it with vagrant destroy.

Resources

  • Design mockups of the rails app are in the design directory.
  • The project list for HackWeek9 is in the Wiki.
  • There are some tools in the tool directory.
  • Data of past hackweeks is in the archive directory.
  • The source of the old webpage is in the gh-pages branch.

hackweek's People

Contributors

ana06 avatar ankushmalik avatar bgeuken avatar bisht-richa avatar biswesh456 avatar cassiux avatar cornelius avatar cyntss avatar depfu[bot] avatar digitaltom avatar dragotin avatar eduardoj avatar evanrolfe avatar hennevogel avatar jordimassaguerpla avatar kirushik avatar namangupta01 avatar purp avatar rishabhptr avatar thutterer avatar tserong avatar

Watchers

 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.