Projects Rundfunk MITBESTIMMEN
23epvyn

Rundfunk MITBESTIMMEN

Public broadcasting in Germany receives €8,000,000,000 (eight billion euros) annually, yet it is subject to little or no public feedback, ranking, or even debate on what constitutes value or quality. We want to change that: With this app you can make your voice heard and propose on which shows your €17.50 per month should be spent.


rundfunk-mitbestimmen

Join the chat at https://gitter.im/rundfunk-mitbestimmen/Lobby Build Status

Public broadcasting in Germany receives €8,000,000,000 (eight billion euros) annually, yet it is subject to little or no public feedback, ranking, or even debate on what constitutes value or quality.

We want to change that: With this app you can make your voice heard and propose on which shows your €17.50 per month should be spent.

Live App

Visit rundfunk-mitbestimmen.de

Structure

This repository contains three important folders:

  1. frontend (EmberJS)
  2. backend (Ruby on Rails)
  3. features (Cucumber/Capybara)

Backend

The backend is responsible to store the data. Who wants to pay for which broadcast and how much? Users are related to broadcasts via impressions in the database. The response on the impression model can be either negative, neutral and positive and indicates whether a user wants to give money to a broadcast. If the response is positive, the amount further specifies how much to pay for a broadcast. So, the sum of all amounts per user must not exceed the monthly fee of 17,50€ per month.

ER diagram

Frontend

The frontend should be as easy to use as possible. The user can login and register, fetch a set of not yet voted broadcasts, decide about broadcasts, assign money and see the public statistics. Most of these actions will send requests to the backend. The frontend should be comfortable to use, e.g. by default amounts are evenly distributed with the option to set the amount explicitly.

Process diagram

Features

We do full stack testing with Cucumber and Capybara. We specify the requirements as user stories in our Github issues and implement them as cucumber features. The cucumber features are a good starting for you to understand the current behaviour and the reasoning behind it.

Here is our model how to write tests. The cucumber tests are at the top. As they test the entire stack, cucumber tests tend to be rather slow in execution but in return they deliver some confidence that the system works. Testing pyramid

Installation and Usage with Docker

Make sure you have docker and docker-compose installed:

$ docker --version
Docker version 18.05.0-ce, build f150324782
$ docker-compose --version
docker-compose version 1.22.0, build unknown

Clone the repository:

git clone https://github.com/roschaefer/rundfunk-mitbestimmen.git

You can setup the development environment with:

cd rundfunk-mitbestimmen
docker-compose up

This can take a while... As soon as this is finished, create the database and run migrations with:

docker-compose run --rm backend bin/rails db:create db:migrate

App is running on localhost:4200

If you want, you can create some seed data

docker-compose run --rm backend bin/rails db:seed

Run frontend tests:

docker-compose run --rm frontend ember test

Run backend tests:

docker-compose run --rm backend bin/rspec

For fullstack testing, use the provided docker-compose override:

docker-compose -f docker-compose.yml -f docker-compose.fullstack-testing.yml up

When all containers are up, run the cucumber tests in the fullstack service with:

docker-compose run --rm fullstack bundle exec cucumber

Local Installation

Make sure that you have a recent version of node, yarn, EmberJS, ruby and postgresql installed before you proceed. E.g. we have the following versions:

$ node --version
v10.4.1
$ yarn --version
1.7.0
$ ember --version
ember-cli: 3.1.4
node: 10.4.1
os: linux x64

$ ruby --version
ruby 2.4.1p111 (2017-03-22 revision 58053) [x86_64-linux]
$ psql --version
psql (PostgreSQL) 9.6.5

Clone the repository:

git clone https://github.com/roschaefer/rundfunk-mitbestimmen.git

Install dependencies and run migrations:

  1. Install dependencies for full stack testing
cd rundfunk-mitbestimmen
bundle
  1. Install frontend dependencies
cd frontend
yarn install
  1. Install backend dependencies
cd ../backend
bundle
  1. Setup the database

(OPTIONAL): Customize the file backend/config/database.yml to match your local database configuration.

Now create the databases and run the migrations:

bin/rails db:create db:migrate
  1. If you want, you can create some seed data
cd backend
bin/rails db:seed
cd ..

Usage

Start the backend and sidekiq:

cd backend && bin/rails s
cd backend && bundle exec sidekiq

Open another terminal and start the frontend:

cd frontend && ember server

App is running on localhost:4200

Full stack testing

Run the frontend server:

cd frontend && ember server --environment=fullstack

Open two more terminals and run the backend server and sidekiq:

cd backend && bin/rails server --environment=fullstack
cd backend && bundle exec sidekiq

Open yet another terminal and run the tests:

bundle exec cucumber

These environments serve the purpose to

  1. Stub out external services in the frontend, e.g. authentication via Auth0.
  2. Use a separate test database in the backend, which will be cleaned after each test run.

If you want to run chrome or firefox instead of headless chrome, you can set an environment variable:

bundle exec cucumber DRIVER=chrome

or

bundle exec cucumber DRIVER=firefox

Frontend tests

cd frontend && ember test --server

Backend tests

cd backend && bin/rspec

Contributing

We use this milestone as priority queue for issues.

High prioritized issues will go to the top. Issues are tagged with backend and frontend depending on where code needs to be changed.

Because GitHub lacks functionality to display estimation hours, we use Zenhub's browser plugin. Installing this plugin will show you the estimated hours per issue.

Don't be afraid about Auth0. As long as your local installation runs in development environment your login will reach the "Testing" database of Auth0. This will not pollute the production database of Auth0.

Workflow for contributing:

  1. Fork it 🍴
  2. Pick a user story from the backlog
  3. Create your feature branch: git checkout -b [issue number]_my_new_feature_branch
  4. Createfeatures/[site of change]/your.feature and copy+paste the feature description from GitHub
  5. Boot both frontend and backend as described in the section about testing
  6. Run bundle exec cucumber
  7. Append the terminal output to features/step_definitions/steps.rb and write expectations
  8. Run bundle exec cucumber - tests should fail
  9. Implement the feature
  10. Run bundle exec cucumber - tests should pass
  11. Commit your changes: git commit -am 'Add some feature'
  12. Push to the branch: git push origin -u [issue number]_my_new_feature_branch
  13. Submit a pull request ❤️

See our detailed contribution guidelines 🔍

Deployment

Our build server Travis CI takes care about automatic deployment. Approximately 15 minutes after your pull request was merged into master, you should see the changes in production.

Useful Links

License

See the LICENSE file for license rights and limitations (MIT).

Related documents

  • Videos - created by Robert Schäfer over 1 year ago

Rundfunk-Mitbestimmen Meeting - Wednesday, 19th Sep at 06:00pm (UTC)


Latest Project videos

Video Host Published
Rundfunk-Mitbestimmen Meeting - Wednesday, 19th Sep at 06:00pm (UTC) Robert Schäfer 18:05 19/09
RF - Wednesday, 19th Sep at 12:07pm (UTC) aonomike 12:07 19/09
Rundfunk-Mitbestimmen Meeting - Wednesday, 12th Sep at 06:00pm (UTC) Robert Schäfer 17:49 12/09
RFM Pair programming Fun - Wednesday, 12th Sep at 09:40am (UTC) aonomike 09:42 12/09
Rundfunk-mitbestimmen pairing ember-fastboot ninja pairing - Wednesday, 5th Sep at 07:00pm (UTC) Matthew Rider 19:00 05/09
Rundfunk-Mitbestimmen Meeting - Wednesday, 5th Sep at 06:00pm (UTC) Robert Schäfer 18:03 05/09
RFM Pair programming Fun - Wednesday, 5th Sep at 05:10pm (UTC) aonomike 17:08 05/09
Rundfunk-mitbestimmen pairing session - Monday, 3rd Sep at 03:51pm (UTC) Matthew Rider 15:53 03/09
Rundfunk-Mitbestimmen Meeting - Wednesday, 29th Aug at 06:00pm (UTC) Robert Schäfer 18:01 29/08
EmberJS Basics - Components & Routing - Wednesday, 29th Aug at 12:48pm (UTC) Robert Schäfer 12:51 29/08
Rundfunk-Mitbestimmen Meeting - Wednesday, 22nd Aug at 06:00pm (UTC) Robert Schäfer 18:08 22/08
FRM :: FAQ_PAGE Pairing session - Tuesday, 21st Aug at 03:30pm (UTC) faith 15:32 21/08
Rundfunk-Mitbestimmen Meeting - Wednesday, 15th Aug at 06:00pm (UTC) Robert Schäfer 17:58 15/08
Rundfunk-mitbestimmen pairing #336_FAQ_page - Wednesday, 15th Aug at 05:00pm (UTC) Matthew Rider 16:59 15/08
Rundfunk-Mitbestimmen Meeting - Wednesday, 8th Aug at 06:00pm (UTC) Robert Schäfer 17:58 08/08
Pairing on #427 - Friday, 3rd Aug at 08:31am (UTC) Robert Schäfer 08:34 03/08
Finalizing Docker Setup - Thursday, 2nd Aug at 12:06pm (UTC) Robert Schäfer 12:07 02/08
Rundfunk-Mitbestimmen Meeting - Wednesday, 1st Aug at 06:00pm (UTC) Robert Schäfer 18:02 01/08
Rundfunk-mitbestimmen docker fun - Wednesday, 1st Aug at 02:05pm (UTC) Matthew Rider 14:02 01/08
Rundfunk-mitbestimmen pairing #336_FAQ_page - Tuesday, 31st Jul at 05:00pm (UTC) Matthew Rider 16:59 31/07
Rundfunk-mitbestimmen pairing session - Monday, 30th Jul at 10:04pm (UTC) Matthew Rider 22:04 30/07
Rundfunk-Mitbestimmen Meeting - Wednesday, 25th Jul at 06:00pm (UTC) Robert Schäfer 17:50 25/07
RFM Pairing on #390 - Thursday, 19th Jul at 12:51pm (UTC) Robert Schäfer 12:55 19/07
Rundfunk-Mitbestimmen Meeting - Wednesday, 18th Jul at 06:00pm (UTC) Robert Schäfer 17:59 18/07
Rundfunk-mitbestimmen pairing #336_FAQ_page - Friday, 13th Jul at 06:00pm (UTC) Matthew Rider 18:02 13/07

Stories are not supported for issue tracker type used by project Rundfunk MITBESTIMMEN