Jupiterrr/Vorlesungsverzeichnis

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Vorlesungsverzeichnis [![Build Status](https://travis-ci.org/Jupiterrr/Vorlesungsverzeichnis.png?branch=master)](https://travis-ci.org/Jupiterrr/Vorlesungsverzeichnis) [![Code Climate](https://codeclimate.com/github/Jupiterrr/Vorlesungsverzeichnis.png)](https://codeclimate.com/github/Jupiterrr/Vorlesungsverzeichnis)
[www.kithub.de](http://www.kithub.de)

For students of the [Karlsruher Institut für Technologie](http://www.kit.edu).



## Getting Started
If you like to run the site lokally feel free to run the bootstrap command. It will guide you through the configuration setup.
```shell
$ script/bootstrap
```

To start the server run
```shell
$ script/server
```

## Built With
- [Ruby on Rails](https://github.com/rails/rails) - Our back end is a Rails app.
- [PostgreSQL](http://www.postgresql.org/) - Our main data store is in Postgres.
- [Heroku](http://heroku.com/) - Our hosting platform is Heroku.

<!---
## Documentation
[Tomdoc](http://tomdoc.org/)
--->

<!---
## Testing
### Unit Tests
For testing we use rspec.
You can find more information about rspec here:

* [Relishapp - Documentation RSpec Core 2.4](https://www.relishapp.com/rspec/rspec-core/v/2-4/docs)
* [Rubydoc - RSpec Core](http://rubydoc.info/gems/rspec-core)

### Feature Tests
Every feature that the user faces and driectly interact with should be tested. We use cucumber for these kind of tests. You can find them in `features/`.

Cucumber is faily easy to use. Just write the test in plain english like the existing ones and run cucumber. It will tell you what to do.

To run these test type
```
$ script/cucumber [File]
```

When you run test with the @javascript tag cucumber will use phantomjs and won't print an helpful error messag or backtrace for 500 Internal Server Errors.
With a little hack you can now find the proper error message in `log/diagnostic.log`.
But most often you can easily reproduce the error in your development environment.
--->

## Author
Carsten Griesheimer:
[Twitter](https://twitter.com/jupiterrrr),
[Github](https://github.com/Jupiterrr),
[Personal page](http://carstengriesheimer.de)

## Copyright / License
> Copyright © 2013 Carsten Griesheimer (hallo@carstengriesheimer.de)