Series Reviews

A different way to share and read TV series reviews, built on Ruby on Rails.

Series-Reviews offers you a new way to share your reviews about TV series, and read other users'. It provides a simple interface where the reviews are grouped into categories, and can be voted by other users. It is created to be used as a desktop app, so there may be design issues on mobile version.

Features

• Sign up and login with a username (no password required)
• Create, edit and delete reviews
• Vote for reviews
• Featured review (most voted) on cover
• Categories with most recent review as cover

Built With

• Ruby (version 2.6.5)
• Ruby on Rails (version 5.2.4)
• Rspec and FactoryBot for testing
• Postgres as database
• HTML5, CSS3 and Javascript in frontend
• Bootstrap for styling
• Slick for carousel
• Simple Form for forms
• Rubocop as linter

Live Demo

Series-Reviews

Entity Relationship Diagram

Automatically generated entity-relationship diagram (ERD) for models, using gem rails-erd. The generated pdf file can be found here.

Getting Started

Prerequisites

• Ruby (version 2.6.5) - To install it, check the official page.
• Rails (version 5.2.4) - Check this page for more info.
• Postgres (version >= 9.5) - More information on the official page.

Setup

Inside the terminal:

• Clone this repository: git clone https://github.com/flpfar/series-reviews.git
• Navigate to the project folder: cd series-reviews
• Run the following commands:

$ bundle install
$ rails db:migrate
$ rails db:seed
$ rails server

Usage

Open a web browser and type http://localhost:3000/ on the address bar.

Run tests

This project uses RSpec for unit testing. In order to run the tests, type rspec inside the terminal.

Generate ERD

To regenerate the ERD pdf file for this project, run bundle exec erd --attributes=foreign_keys,timestamps,content in the terminal.

Future improvements

• Calculate the priority of categories by their number of reviews.
• Responsive layout.
• Admin interface to handle categories.
• Login with password.

Authors

👤 Felipe Augusto Rosa

• Github: @flpfar
• Twitter: @flpfar
• Linkedin: Felipe Augusto Rosa

🤝 Contributing

Contributions, issues and feature requests are welcome!. Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• The specifications and requirements for this project can be found here.
• This project design was based on liFEsTlye website concept by Nelson Sakwa.

📝 License

This project is MIT licensed.