gcivil-nyu-org / dine-safe-ly Goto Github PK

User story

• As a user, I want to view a restaurant's address, operational hours, and other pertinent info such as reviews and services.

Acceptance criteria

• Given that I am a user, I can open a restaurant's page and view information such as average user reviews, hours of operation, and helpful info provided by Yelp.

Definition of Done

• A user can open a page and see basic restaurant information on the landing page.

User story

As a user, I want to be able to report bugs and offer comments/feedback on the application

Acceptance criteria

A user can click on a link and access an email form to offer feedback, suggestions, and/or report bugs.

Definition of Done

User story

• As a User, I want to be able to Update my Password.

Acceptance criteria

• I am able to login with a new password after changing my credentials

Definition of Done

• The New Password stored in the database for that particular user.
• Review and testing is completed.

User Stories

• As a user, I want to have access to restaurant inspection data so that I may determine whether an establishment is suitable for my needs.

Acceptance Criteria

• Given that I am an admin, I should be able to reliably fetch the latest inspection results and provide this information to users.
• Given that I am a user, I should be able to view a restaurant's inspection history.

Definition of Done

• Users have access to the most recent inspection data.

Login page:

• Username text and input field says email instead of username.
• Should display an error if login credentials are invalid.
• Change background image to food related or New York-related picture?

Register page:

• should also collect username.
• Change background image to food related or New York-related picture?

Restaurant Profile page:

• Find out why inspection data is not populating.
• Reformat opening hours
• Remove Amenities section

Inspection History page:

• Remove time from inspection date.

User story

• As a user, I want to be able to create an account so that I can have a personalized experience and save my favorites.

Acceptance criteria

• Given that I am a user, I should be able to register an account to personalize my experience.

Definition of Done

• Users can create a new account.

User story

• As a user, I want to be able to log in to my account in order to access my profile.

Acceptance criteria

• Given that I am a registered user, I should be able to login with a valid username and password.

Definition of Done

• Users can login to their account.
• Tested with dummy data.
• Pull Request reviewed and merged.

User story

• As an admin, I want to define a database schema containing restaurant data, inspection details and key attributes.

Acceptance criteria

• As an admin, I am able to retrieve data using fields defined in the schema, such as restaurant name, date of inspection, etc.

Definition of Done

• There is a clearly defined database schema that allows the admin to access values by field and attributes.

User story

• As a user, I want to view whether the restaurants lie in COVID-19 Hot Spots.

Acceptance criteria

• Users may view a restaurant relative to other hot spot zones.

Definition of Done

• Safe or Risky status for each restaurant on it's details page.
• Users can provide location data and view nearby restaurants on a map.
• Users can modify their location and view updated results on a map.
• Unit tested and reviewed.

Create an admin page for database management.

User story

• As an admin, I want to retrieve the most recent restaurant inspection data so that users have the latest safety information.

Acceptance criteria

• Given that I am an admin, I should be able to retrieve the most recent data and provide this information to users.

Definition of Done

• Users have access to the most recent inspection data.

Activity Diagram

User story
As an admin, I want to search the database so that I may identify and extract meaningful data points.

Acceptance criteria

• As an admin, I should be able to identify column data for business identification, location, and inspection details.
• As an admin, I should be able to parse through a processed database and extract relevant data points.

Definition of Done

• Meaningful data can be extracted from the database.

User story

Acceptance criteria

Definition of Done

We need more clear inspection history formatting, and offer some information regarding inspection results.

User story

• As a user, I want to view feedback statistics so that I can consider all safety information.

Acceptance criteria

Definition of Done

Design and develop Webpages which the user can access to view data in an ordered and clean manner

Backend:

• Search based on restaurant name keyword
• Search based on restaurant location (zipcode)

Maybe just integrate this for filter:

• Search based on restaurant categories

Frontend:

• Reformat browse page

Definition of done:

• Browse page should display the correct results of search and filter;
• We should be able to apply filter to the search results;

User Stories

• As a user, I want to search for restaurants by text information such as name, address, cuisine, etc.
• As a user, I want to search for restaurants on the map overlay so that I find restaurants near me.

Acceptance Criteria

• Given that I am a user, I should be able to search for restaurants based on different criterias such as cusine, adress, etc.
• Given that I am a user, I should be able to open the map overlay and search for restaurants based on location.

Definition of Done

• Users should have the functionality of searching restaurant information based on different criterias.
• The search results are based on the dataset we choose.
• The search results can be displayed on map.

User story

• As an admin, I want to preprocess and filter raw data and according to a database schema.

Acceptance criteria

• Given that I am an admin, I should be able to feed raw data into a script and process values according to the requirements of a predefined database schema.
• Given that I am an admin, I should be able to store and organize processed data into defined fields.

Definition of Done

• Processed data has unique identifiers to mitigate duplicate or ambiguous entries.
• Processed data is in a usable format and accessible for API calls.

Activity Diagram

User story

• As a user, I want to be able to reset a forgotten password.

Acceptance criteria

• Given that I am a registered user, I can provide my contact email to reset a forgotten password.
• Given that I am a registered user, I will receive a password reset link to my contact email.
• Given that I am a registered user, I have a set duration to reset my password before my reset link expires.
• Given that I am a registered user, I cannot reset my password to a previously used password.

Definition of Done

• Users who have submitted a valid contact email will receive a timed reset link.
• Users who have successfully reset their passwords may login with their new credentials.
• Unit tested and reviewed.

User story

• As a user, I want to be able to register for an account so that I may receive customized results.

Acceptance criteria

• Given that I am a user, I be able to register for an account if I provide a unique username, email, and a valid password.

Definition of Done

• Users can register for a new account with valid credentials.

• Unit tested and reviewed.

• Define user database model

• Create, Read, Update, Delete operations for user (API)

• User sign up page

make sure to add seating choice to model.

User story

• As a user, I want to filter restaurants by attributes so that I can access restaurants by category on a browse page
  Acceptance criteria
  Filter by:
• Category
• Ratings
• Price $$$
• neighborhood

Definition of Done

• Getting filtered restaurants based on filter attributes.
• Filter feature should work with search feature

User story

• As an admin, I want to update the database on a regular basis to maintain the latest inspection details.

Acceptance criteria

• As an admin, I can establish regular time intervals to query Open Data metadata.
• As an admin,

Definition of Done

• After each update, the data in the database must be consistent with the data in the data set.
• Every update can be triggered on time.
• Every update can be completed efficiently.

Activity Diagram

User story

• As a user, I want to get instant recommendation so that I can choose the best fit restaurant baed on the data.

Acceptance criteria

• Given I am a user, I can have the option to get instant recommendation without entering additional information.
• Given I am a user, I can receive the recommendation by text or email.

Definition of Done

• The recommendation is auto-generated based on the dataset.
• The results of recommendation can be sent to user via text/email.

Need to create a .env file to store secrets and api keys

User story

• As a user, I want the option to search restaurants by map so that I may assess travel options and overall proximity.

Acceptance criteria

• Given that I am a user, I should be able to specify my location and view nearby restaurants within a certain radius.
• Given that I am a user, I should be able to adjust my location and see and updated map of restaurants.

Definition of Done

• Users can provide location data and view nearby restaurants on a map.
• Users can modify their location and view updated results on a map.
• Unit tested and reviewed.

User story

• As a user, I want to view a "browse" page so that I may view restaurants by compliance status and other search filters.

Acceptance criteria

• Given that I am a user, I should be able to browse for restaurants on a landing page.

Definition of Done

• Present list of restaurants by card, with clear visual indication regarding compliance (ordered by most recent / compliant-only).

User story

• As a user, I want to provide feedback on my experience so that I may help other users make decisions.

Acceptance criteria

• Given that I am a user, I have the option to answer basic questions related to the restaurant's implementation of COVID safety features. (6 feet distance between tables, adequate ventilation, temperature checks, etc).

Definition of Done

• Users can submit yes/no questions pertaining to COVID restaurant guidelines.

User story

• As a user, I want to be able to login to my account.

Acceptance criteria

• Given that I am a registered user, I can login to my account with a valid username and password.
• Given that I am a registered user, I do not have to log in again in the same session, unless I log out or my session expires.

Definition of Done

• Users can login to their accounts with valid credentials.

• Users are logged in for duration of authentication session.

• Unit tested and reviewed

• Authentication/Session management

• Different front end based on current session (logged in/logged out) (i.e. navigation bar for sign in)

• User Login page

User story

• As a user, I want to be able to update my password.
• As a user, I want to be able to reset a lost password.
• As a user, I want to be able to update my personal information/ preferences.

Also reformat restaurant detail page for businesses that do not have yelp API matches.

User story

• As a user, I want to view a restaurant's current compliance status so that I may determine whether an establishment is safe to dine.

Acceptance criteria

• Given that I am a user, I should be able to view current compliance when I access a restaurant's page.
• A restaurant's page will indicate whether a restaurant has no inspection data or has not been inspected recently.

Definition of Done

• Users can view a restaurant's inspection status.
• Unit tested and reviewed.

The Data Management epic name is too generic and confusing.

there are some "dummy" entries in the inspection database that should be removed before we populate.

implement logger for exceptions and debugging

handle dictionary processing on the front end, rather than passing template variables?

User story

• As a user, I want to view a restaurant's inspection history so that I can see if a business has regularly maintained compliance.

Acceptance criteria

• A user can open a restaurant's inspection page and see an updated list of inspection history.

Definition of Done

• Each restaurant page will have an accessible link to its historical inspection data.
• Code is reviewed and tested.