veelenga / cybfootball

Футбольні турніри факультету кібернетики

Cybfootball

Setup

1. Install ruby of version 2.4.1: https://www.ruby-lang.org/en/documentation/installation/

2. Install postgresql of version 9: https://wiki.postgresql.org/wiki/Detailed_installation_guides

3. Clone repo and go to app root dir:

$ git clone https://github.com/veelenga/cybfootball
$ cd cybfootball

4. Install bundler and all required dependencies:

$ gem install bundler
$ bundle install

5. Create and migrate database, run tests:

$ bundle exec rake db:create
$ bundle exec rake db:migrate
$ bundle exec rake db:seed
$ bundle exec rake db:migrate RAILS_ENV=test
$ bundle exec rspec

6. Start app:

$ bundle exec rails server

Data from the book

The information about the players, teams and the tournaments is located by the link https://drive.google.com/drive/folders/0B19XYNc9CGKzMGl4cnNTdVVyUWc?usp=sharing

FB group

There are a bunch of the photos from the several tournaments. https://www.facebook.com/groups/341895829498550

cybfootball's Issues

User login via facebook omniauth

In #7 we would implement a way to login admin. This ticket is about to sign in regular user so he would be able to do some action in our app, like adding comments to players/teams/tournaments, leaving some feedback or requesting changes in resources. This might be valuable, 'cause would help to reduce the mistakes in user names, descriptions etc.

We would like to support only omniauth, and for now facebook is enough.

http://sourcey.com/rails-4-omniauth-using-devise-with-twitter-facebook-and-linkedin/

Anonymous updates

We want to allow anonymous updates. So real people by themselves could contribute.

• Anonymous should be able to:

  1. Submit edits for tournament/team/player fields
  2. Submit new team/player

• Anonymous should prove that he is a human using google captcha.

• Submission should be approved by admin or trusted editors. They are going to see a list of submissions (ideally with a diff if this is an edit) and should be able to accept, reject or edit each submission.

• Submission should be automatically deleted once it is processed.

Thoughts ?

Missing translation

Image cropper

Each team and player are going to have avatars. To be well shown to user on index page, avatars need to have equal sizes. For this we can use image cropper. Checkout this railscasts for details: http://railscasts.com/episodes/182-cropping-images?autoplay=true

Player avatar need to be squared, team avatar need to be rectangular (where w > h).

The same technic uses Github while uploading user avatar.

Tests for react components

Would be nice to have to lock changes and prevent issues during upgrade:
https://facebook.github.io/jest/docs/tutorial-react.html

Static pages

We need to develop two additional pages:

• "about" page which describes what this app for and what user can do here
• "contact" page where user can contact us easily via https://formspree.io/

Add button to switch language on navigation bar

Coming release plans

The things to be done till we release:

• setup production and stage envs.
• #40
• #41
• #42
• move to custom domain
• make the repo public
• prepare informational pages /about, /contact, /faqs

Google analytics

Better pagination

We think pagination with numbers of pages (i.e. Prev 1 2 3 4 5 6 7 8 Next) is useless. So this task is about add just two buttons Prev, Next

Save "per_page" across page reloads

We developed ajax pagination and it works nicely. But for now once user go to a different page (or just reload the current one), "per page" parameter is set to default (20). And this is really inconvenient if he prefers non-default per page value.

This task is about to save "per_page" value chosen by user on a particular page and use his last choice once he is again on this page. User should be able to have different "per page" preferred values for different pages.

Hint: use cookies or localStorage or what is more suitable for this kind of task.

Convenient way to create tournaments

Admin should have a very useful, simple and intuitive way to create new tournament.

Creating tournament means:

• create new tournament (with date, description, number)
• add teams
• create group(s)
• add matches
• add players ( create if there is a new one )
• add goals with authors

Ideally would be if the system could automatically create tables, calculate points, chose winner.

Tournament date field improvement

In bf23d76 (feature/tournament_date) I added a basic setup for a date field:

Please improve tournaments#edit & tournaments#new (the actual code is here) pages so the user will have a date field that will match the following requirements:

• default date (while creating new tournament) should be today (this need to be set on model, here is example)
• add validation to Tournament model, so we will validate the date on backend with min year: 1990, max year: current_year + 1. Checkout active_record_validations for details.

Please add tests accordingly.

Tournament.no field improvements

Tournament.no field represents a number of the tournament. This field is uniq and has a direct connection to the number of the tournament in the book (i.e. Tournament №50).

Currently user has to enter the no on his own (while creating a tournament), what is super inconvenient. Let's improve it with:

1. Drop down (instead of a spin box) with available values 1..100 (+ validation on backend).
2. Default value: latest used no + 1 (yes, that's it Tournaments.last.no + 1)

Sitemap & RSS feed

Old drupal site

If someone interested, here is a source for the old site: http://www.ex.ua/345737034633. It uses Drupal + Php. I have found nothing we can reuse, but might be interesting to configure, run and overview.

Be free to reopen this, if you found something interesting for us there ;)

/cc @makarychev @andriipanasiuk

Internationalization support

Follow this guide to setup internationalization.

Supported languages: only ua
Fallbacks: en

Views, error/warning/info messages, pagination, model validation messages

Admin log-in using devise

Create sign-in page, login/logout actions:

https://github.com/plataformatec/devise

For now, only admin should be able to login, create/update/delete(CUD) resources and see CUD buttons/links. But probably in future we will let other users to be able to login, so we can start creating role model.

Also we have to deny access on controller side, so the user will not bypass. Each of those might help:

https://github.com/CanCanCommunity/cancancan
https://github.com/elabs/pundit
https://github.com/nathanl/authority

Tournament/Player/Team gallery

Each of those should have a small (10-15 photos) gallery. Admin should be able to upload photos, guest should be able to review.

For storage we can use aws s3 with some suitable plan: https://aws.amazon.com/s3/pricing/

We use paperclip for attachments, and would be able to optimize image size (while uploading) to save some money:

https://github.com/emrekutlu/paperclip-compression
https://github.com/janfoeh/paperclip-optimizer

Add flash messages

After create/update/delete action a plenty of flash notices are generated but currently not shown. Display those messages at the top using bootstrap style.

Here is a good sample: https://gist.github.com/suryart/7418454