/travel-support-program

A rails app to support the travel support program of openSUSE (TSP)

Primary LanguageRubyGNU Affero General Public License v3.0AGPL-3.0

Travel Support Program management application

Build Status Coverage Status

About

This is a Ruby on Rails based application to manage the requests and reimbursements from travel help programs of free software organizations like the openSUSE Travel Support Program, the GNOME's Conference Travel Subsidy Program or the KDE e.V. Travel Cost Reimbursement initiative.

Although been developed initially at the openSUSE Team at SUSE, the goal is to write a generic application including all the common features so it can be extended and adapted to fulfill the needs of any organization. This is achieved using widely used and flexible components like Bootstrap for the frontend layout or Devise for user authentication.

For a more detailed explanation you can refer to the {file:doc/ABOUT.md} file, in which 'the 6 Ws' are developed. That is: who, what, when, where, why and how (yes, we already know that 'how' does not start with 'W', but we didn't invented the name).

Requirements

  • Ruby >= 1.9
  • Any Rails supported database system: PosgreSQL, SQLite3, MariaDB, MySQL...

Getting Started

As most regular Ruby on Rails applications:

$ git clone https://github.com/openSUSE/travel-support-program
$ cd travel-support-program
$ vi Gemfile # edit Gemfile to uncomment your favorite database driver
$ bundle
$ cp config/database.example.yml config/database.yml
$ cp config/site.example.yml config/site.yml
$ vi config/site.yml # edit configuration DON'T FORGET to set proper secrets
$ rake db:create db:migrate db:seed
$ rails s

You can access the application pointing your browser to http://localhost:3000/ Four initial users should be available with the following emails and passwords:

Contact

Ancor González Sosa

License

This application is released under the terms of the GNU Affero General Public Licence (AGPL). See the {file:LICENSE} file for more info