Welcome

This is the code of hcking.de. Hcking.de is an event calendar for geeks in and around Cologne.

We discuss features and problems in our google group.

Scope of Hcking.de

When you want to add an event to hcking.de please check with the following guidelines:

• Currently we only feature events in Ruhr area plus BIG events in europe
• The following topics are allowed:
  • Programming (in any language)
  • Nerd-Culture (like Star Wars, Ponies, Gaming, Comics...)
  • Software Development Methods and Software Engineering
  • Electronics and Robots
  • Networking

Getting Started

If you want to work on the Project, follow the steps described here:

1. Fork the Project
2. Check out your fork
3. cd into the directory, install the bundler gem and run bundle install
4. Now create a database config: cp config/database.yml_example config/database.yml

• The example config requires MySQL including a database and a user
• You can instead use SQLite3
• More information on the database config

1. Create the Devise & Omniauth configuration cp config/initializers/devise.rb_example config/initializers/devise.rb and edit the keys
2. Now run rake db:migrate to setup your database
3. To run your application locally you can now use rails server
4. Now visit http://localhost:3000 in your webbrowser and you are ready to go!

If you want to add Events to your local page, you need an administrator:

1. Run rake setup:admin
2. Now you can log in with your new administrator ;)

Pow

Pow is a really comfortable way to run the application on your machine. You can learn everything about it here.

Guard

If you are in the project directory, you can start Guard with guard. This will offer you the following comfortable features:

• LiveReload: If you are on Mac OS X and you have livereload installed, your browser will automatically load changed CSS, JS and HTML data.
• Pow: Pow will get restarted automatically when necessary.
• Bundler: Bundler will run, when the Gemfile changes
• Yard: On http://localhost:8808 you will have a documentation server running
• Spork: A Spork instance will run in the background, which makes your tests faster
• Test: If you make changes to a test or a application file, the according tests will run and you will get feedback.

Testing

Hcking is developed in a test-driven way using Test::Unit and FactoryGirl. If you want to contribute to the project always add tests for your added functionality. If you find a bug it would be really helpful if you add a regression test that displays this misbehaviour. Even better: Fix it afterwards ;)

Note on Patches/Pull Requests

See CONTRIBUTING.md for details