Contributors:
- Grayson McLead
- Elias Ramirez
- Anel Tuyebayeva
This is a group project to build a website app that is similar to Yelp. Where you can create an account as a regular user and search any listed businesses by name or type, as well as reviewing them. As a business owner, you can create an account and be able to list your business, as well as edit and delete your business listing.
- The page has a set of always-visible links (described in Site Sections).
- When I load the page, I am on the home section. The page is on the logged-out state: only Home, All Businesses, Signup, and Login links are visible.
- I can create an account. Emails must be unique. If I use a duplicate email, I see a message indicating this. After successful account creation, I am back on the home section, and the page is in the logged-in state.
- In the logged-in state, only Home, All Businesses, List Your Business, and Logout links are visible.
- If I close and re-open the page, it remembers my logged-in / logged-out state.
- The logout link logs me out and displays the home section.
- The login link reveals a login form. When submitted, if login is successful, I'm taken to the logged-in state of the home page. If unsuccessful, I'm shown a message indicating so.
- The All Businesses link takes me to the All Businesses section described below. Same for List Your Business.
- When I click on the List Your Business link, I see a form that lets me create a new business, with fields for name, address, description, and type. The type is a dropdown that lets me pick from one of a number of pre-defined business types (restaurant, clothing, etc). After submitting this form, I'm taken to the All Businesses section, which now contains my new business.
- Clicking on the name of a business in the All Businesses section takes me to the Single Business view for that business. Here I can see the name, address, type, and description of this business. I can also see the name of the user who listed it.
- Beneath this (still in Single Business view), I can see a list of all reviews that have been left on this business, along with the name of the user who left the review. Each review has headline, a content, and an integer rating out of 5. Reviews are ordered with the most recent review at the top, and the oldest review at the bottom.
- Still in Single Business view, IF I am logged in, there is a form to leave a review (also consisting of headline, content, and rating out of 5). (If I am not logged in, this form is not present.) This form is sandwiched between the business info and the list of reviews, so that I don't have to scroll all the way to the bottom of a potentially long list of reviews to get to it. When the form is submitted, the new review appears at the top of the list.
Method | Path | Description |
---|---|---|
POST | /users | create new user |
POST | /users/login | user login |