Skip to content

Latest commit

 

History

History
89 lines (78 loc) · 3.3 KB

README.md

File metadata and controls

89 lines (78 loc) · 3.3 KB
Raw

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
  2. Set up the development environment: 
    docker-compose run --rm hackweek bundle exec rake dev:bootstrap
  3. Start the development environment: 
    docker-compose up --build

Vagrant

  1. Install VirtualBox and vagrant
  2. Install vagrant-exec plugin: 
    vagrant plugin install vagrant-exec
  3. Start our openSUSE 42.3 based virtual machine with vagrant: 
    vagrant up
  4. Launch the application: 
    vagrant exec foreman start
  5. Access the appliaction as usual: 
    xdg-open http://localhost:3000
  6. Start hacking
  7. Test your changes 
    vagrant exec rspec
  8. Send pull request
  9. $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.