mirror of
https://github.com/openSUSE/osem.git
synced 2026-08-13 19:54:02 +00:00
72 lines
2.9 KiB
Markdown
72 lines
2.9 KiB
Markdown
[](https://travis-ci.org/openSUSE/osem)
|
|
[](https://codeclimate.com/github/openSUSE/osem)
|
|
[](https://coveralls.io/r/openSUSE/osem)
|
|
[](https://hakiri.io/github/openSUSE/osem/master)
|
|
#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.](http://guides.rubyonrails.org/getting_started.html)
|
|
|
|
### 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. Generate secret key for devise and the rails app with
|
|
```
|
|
rake secret
|
|
```
|
|
Look at config/config.yml.example.
|
|
|
|
5. 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.
|
|
|
|
10. 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](https://www.phusionpassenger.com/download/#open_source)
|
|
and the [apache web-server](https://www.apache.org/). 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](http://rspec.info/)+[capybara](http://jnicklas.github.io/capybara/)+[factory girl](https://github.com/thoughtbot/factory_girl) to build test suite. You *should* run it continuously when you are developing, via:
|
|
```
|
|
bundle exec guard
|
|
```
|
|
This uses [spring](https://github.com/rails/spring) to provide a
|
|
[fast feedback loop for the red/green cycle](http://bitzesty.com/blog/2013/05/enable-tdd-with-faster-ruby-on-rails-stack-reloading/).
|