#OSEM The Open Source Event Manager. An event management tool tailored to Free and Open Source Software conferences.

Install OSEM

You can run rails apps in different modes (development, production). For more information about rails and what it can do, see the rails guides.

Run OSEM in development

1. Clone the git repository to the directory you want Apache to serve the content from.

git clone https://github.com/openSUSE/osem.git

2. Install all the ruby gems.

bundle install

3. Install ImageMagick from your distribution repository
4. Copy the sample configuration files and adapt them

cp config/config.yml.example config/config.yml
cp config/database.yml.example config/database.yml

6. Setup the database

bundle exec rake db:setup

7. Run OSEM

rails server

8. Visit the APP at

http://localhost:3000

9. Sign up, the first user will be automatically assigned the admin role.

Run OSEM in production

We recommend to run OSEM in production with mod_passenger and the apache web-server. There are tons of guides on how to deploy rails apps on various base operating systems. Check Google ;-)

Documentation

OSEM is extensively (some would say maniacally ;-) documented. You can generate a nice HTML documentation with ''rdoc''

bundle exec rdoc --op doc/app --all -f fivefish app 
xdg-open doc/app/index.html 

Testing

We are using rspec+capybara+factory girl as test suite. You should run it, whenever you change something, with

bundle exec rake rspec

Contributing

We are always looking for contributions to OSEM. Here is how you can:

• Fork the repository and make a pull-request with your changes
  • Make sure that the test suite passes (we have travis enabled) before you request a pull and that you comply to our ruby styleguide (we make use of hound-ci).
  • Please make sure to mind what travis and hound tell you! :-)
• One of the OSEM maintainers will review your pull-request
  • If you are already a contributor (means you're in the group osem-committers) and you get a positive review, you can merge your pull-request yourself
  • If you are not a contributor already please request a merge via the pull-request comments