gunghogeoduck/osem-fcy
1
0
Fork 0
mirror of https://github.com/openSUSE/osem.git synced 2026-08-13 19:54:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Furrest City's modified version of OSEM http://osem.io
661 commits 15 branches 2 tags 50 MiB
Find a file
Stella Rouzi 9eeb60b5cd Documentation about using OpenID
2014-06-20 15:26:15 +03:00
app Added photo model 2014-06-19 21:09:15 +05:30
bin Rails 4 has different init script location we should conform 2014-04-24 21:41:53 +02:00
config Documentation about using OpenID 2014-06-20 15:26:15 +03:00
db Added photo model 2014-06-19 21:09:15 +05:30
doc First checkin 2013-01-07 09:04:09 +01:00
lib First checkin 2013-01-07 09:04:09 +01:00
public First version of the non-js schedule. Removed the assets from version control. 2013-06-19 13:58:48 +02:00
spec Added photo model 2014-06-19 21:09:15 +05:30
vendor First checkin 2013-01-07 09:04:09 +01:00
.gitignore Do not add rubocop config 2014-06-17 10:50:46 +02:00
.hound.yml configure houndci to allow lines up to 100 chars 2014-05-15 21:25:29 +03:00
.travis.yml Migrate all secrets to config/secrets.yml 2014-05-12 18:32:26 +02:00
config.ru First checkin 2013-01-07 09:04:09 +01:00
CONTRIBUTING.md Add rubocop to Gemfile 2014-06-17 22:50:00 +03:00
Gemfile Update awesome_nested_set 2014-06-19 08:07:30 -07:00
Gemfile.lock Update awesome_nested_set 2014-06-19 08:07:30 -07:00
Guardfile Add support for guard and spring 2014-04-27 23:42:32 +02:00
LICENSE Release osem under MIT. Fixes #57 2013-10-18 15:33:59 +02:00
Rakefile First checkin 2013-01-07 09:04:09 +01:00
README.md Documentation about using OpenID 2014-06-20 15:26:15 +03:00

README.md

Build Status Code Climate Coverage Status Security Status #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
  1. Install all the ruby gems.
bundle install
  1. Install ImageMagick from your distribution repository
  2. Generate secret key for devise and the rails app with
rake secret

Look at config/config.yml.example.

  1. Copy the sample configuration files and adapt them
cp config/config.yml.example config/config.yml
cp config/database.yml.example config/database.yml
  1. Setup the database
bundle exec rake db:setup
  1. Run OSEM
rails server
  1. Visit the APP at
http://localhost:3000

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

  2. Use openID In order to use the OpenID feature you need to register your application with the providers (Google and Facebook) and enter their API keys in config/secrets.yml file, changing the existing sample values. You can register as a devoloper with Google from https://code.google.com/apis/console#:access You can register as a devoloper with Facebook from https://developers.facebook.com/

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 to build test suite. You should run it continuously when you are developing, via:

bundle exec guard

This uses spring to provide a fast feedback loop for the red/green cycle.