Backend Module 2 paired Rails project, weeks 2 and 3
This purpose of this application is for users to browse and review books. The primary goal of this challenge is testing your ability to set up many-to-many relationships and accessing attributes through multiple models.
- creation of a basic Rails web application
- implementing basic MVC structure to your project
- save and retrieve data from a database
- display content on a web page with some very basic styling
- learning how to test your code effectively at a Controller and a Model level
- must use Rails 5.1.x
- must use PostgreSQL
- all controller and model code must be tested via feature tests and model tests, respectively
- must use some amount of HTML and CSS layout
- ask instructors in your public channel before adding any gems to your project
- do not use JavaScript to sort content on a page
These user stories may be worked on in any order that makes sense to your team. The most optimal order may not be a top-to-bottom approach.
As a Visitor,
When I visit a book index page,
I see all book titles in the database.
Each book entry on the page shows the author(s) and number of
pages in the book, and the year it was published.
As a Visitor,
When I visit the book index page,
Next to each book title, I see its average book rating
And I also see the total number of reviews for the book.
As a Visitor,
When I visit the book index page,
I should see one link each to sort the books by the following criteria:
- sorted by average rating in ascending order
- sorted by average rating in descending order
- sorted by number of pages in ascending order
- sorted by number of pages in descending order
- sorted by number of reviews in ascending order
- sorted by number of reviews in descending order
As a Visitor,
When I visit the book index page,
I see an area showing statistics about all books:
- three of the highest-rated books
- three of the worst-rated books
- three users who have written the most reviews
As a Visitor,
When I visit a book's show page,
I see the book title, the author(s) and the number of pages
in the book.
I also see a list of reviews for that book.
Each review will have a title and user, a numeric rating
from 1 to 5, and text for the review itself, and all content
must be present for each review.
As a Visitor,
When I visit a book's show page,
I see an area on the page for statistics about reviews
containing information such as:
- the top three reviews for this book (title, rating and user only)
- the bottom three reviews for this book (title, rating and user only)
- the overall average rating of all reviews for this book
As a Visitor,
When I visit the book index page,
I see a link that allows me to add a new book.
When I click that link, I am taken to a new book path.
I can add a new book through a form, including the book's
title, author(s), and number of pages in the book.
When I submit the form, I am taken to that book's show page.
Book titles should be converted to Title Case before saving.
Book titles should be unique within the system.
For authors, a comma-separated list of names should be entered,
and each author will be added to the database.
As a Visitor,
When I visit a book's show page
I see a link to add a new review for this book.
When I click on this link, I am taken to a new review path.
On this new page, I see a form where I can enter:
- a review title
- my name
- a numeric rating that can only be a number from 1 to 5
- some text for the review itself
When the form is submitted, I should return to that book's
show page and I should see my review text.
User names should be converted to Title Case before saving.
As a Visitor,
When I visit an author's show page
I see all book titles by that author
And each book should show its number of pages and any other authors
excluding the author that this show page is about.
As a Visitor,
When I visit an author's show page,
Next to each book written by that author, I should see one of
the highest rated reviews for the book (title, score, and user name).
As a Visitor,
When I click on a user's name for any book review
I am taken to a show page for that user.
I should see all reviews (title, rating and text) that this
user has written.
I should also see links to sort reviews in the following ways:
- sort reviews newest first (descending chronological order)
- sort reviews oldest first (ascending chronological order)
As a Visitor,
When I visit a user's show page,
I see a link next to each review to delete the review.
When I delete a review I am returned to the user's show page
Then I should no longer see that review.
As a Visitor,
When I visit a book's show page,
I see a link on the page to delete the book.
This link should return me to the book index page where I
no longer see this book listed.
(you may need to delete other content before you can delete the book)
As a Visitor,
When I visit an author's show page,
I see a link on the page to delete the author.
This link should return me to the book index page where I
no longer see this author listed.
If this author was the only author for any book, that book is also deleted.
(you may need to delete other content before you can delete the author or book)
As a Visitor,
With the exception of a book's show page,
Anywhere I see a book title on the site,
I can click on the book title to go to that book's show page.
As a Visitor,
With the exception of an author's show page,
Anywhere I see an author's name on the site,
I can click on the name to go to that author's show page.
As a Visitor,
With the exception of a user's show page,
Anywhere I see a user's name on the site for a book review,
I can click on the name to go to that user's show page.
If you finish the user stories above before the deadline, you are expected to attempt extension work.
As a Visitor,
I should not be permitted to save a book review using a name
I've previously used to review a specific book.
As a Visitor,
When I visit a user's show page to see their reviews,
I see additional links to sort their reviews in the following ways:
- sort reviews by highest rating, then by descending date
- sort reivews by lowest rating, then by ascending date
As a Visitor,
When I visit the book index page,
In the Statistics are of the page,
I should also see three authors who have the highest-rated books
As a Developer
I will spend additional time on HTML layout and styling
to create a visually oustanding project
Each paired team will have a rubric uploaded to https://github.com/turingschool/ruby-submissions
- Exceeds Expectations: All features are correctly implemented along with one or more extensions
- Meets Expectations: All features defined in the assignment are correctly implemented and project is deployed
- Below Expectations: There are one or two features missing or incorrectly implemented and/or project is not fully deployed
- Exceeds Expectations: Views show logical refactoring into layout(s), partials and helpers, with no logic present
- Meets Expectations: Views make use of layout(s), partials and helpers
- Below Expectations: Views don't make use of partials or show weak understanding of rendering templates
- Exceeds Expectations: Controller code shows significant effort towards refactoring and pushing logic down the stack
- Meets Expectations: Controller code is generally well organized with three or fewer methods that need refactoring
- Below Expectations: There are many controller methods that should have been refactored
- Exceeds Expectations: Models show excellent organization, refactoring, and appropriate use of Rails features
- Meets Expectations: Models show an effort to push logic down the stack, but need more internal refactoring
- Below Expectations: Models are somewhat messy and/or make poor use of Rails features
- Exceeds Expectations: Best choice ActiveRecord methods are used to solve each problem
- Meets Expectations: ActiveRecord is utilized wherever it can be. There is no Ruby where there should be ActiveRecord
- Below Expectations: Ruby is used to programatically solve problems where ActiveRecord could be used
- Exceeds Expectations: Project has a running test suite that exercises the application at multiple levels and utilizes excellent setup and teardown to maximum productivity and minimize code
- Meets Expectations: Project has a running test suite that covers all functionality and tests at multiple levels
- Below Expectations: Project has sporadic use of tests at multiple levels
- Exceeds Expectations: Project is highly usable and ready to deploy to customers
- Meets Expectations: Project is highly usable, but needs more polish before it'd be customer-ready
- Below Expectations: Project needs more attention to the User Experience, some views need to use a URL to visit them
- Exceeds Expectations: Project utilizes HTML and CSS to its fullest
- Meets Expectations: Project utilizes HTML and CSS but has some area for improvement
- Below Expectations: Project utilizes little or no HTML or CSS
- Exceeds Expectations: Excellent use of branches, pull requests, peer and instructor code review, and a project management tool.
- Meets Expectations: Good use of branches, pull requests, peer and instructor code review, and a project management tool.
- Below Expectations: Sporadic use of branches, pull requests, and/or project management tool.
- Exceeds Expectations: Excellent README which gives users an exemplary guide to the what your application is, how it's used, including screenshots, installation instructions, links to each project member's github, etc.. Supplied DTR is fully complete and professional
- Meets Expectations: A custom README is present and gives users an guide to what your application is about; a DTR is included in the project's root folder as well per Turing's DTR template
- Below Expectations: This project is lacking a README or DTR
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent