-
Notifications
You must be signed in to change notification settings - Fork 0
Requirements
Yujia Wu edited this page Mar 25, 2022
·
2 revisions
The app aims to provide interactive visualised food reviews for our users. Therefore we propose the following must-have features.
- A home feed that shows a list of food review posts which default to sort by location distance and rating. This ensures the closest and highest rating foods will be on the top of the list.
- Each post will contain the restaurant details, the food details and the food review.
- The app allows multiple different users to post reviews on the same restaurant food.
- The app will also come with a user authentication system to allow users to sign up to become members.
- A member (account holder) of the app can post a food review.
- The app will also be implemented with a search function to search for food or restaurants or by related keywords.
The should-have features are less critical than the must-have features, but they are still essential for providing the most satisfying user experiences.
- The option to filter the food post by location, rating and dietary requirements.
- Suggestions for restaurant locations when members post about food.
- A hyperlink of the restaurant location to redirect the user to Google Maps.
- A member can see the post they made, like the food posts and save food posts for future reference.
The could-have and nice-to-have features are the additional features that are less critical and too complicated to achieve within the given time.
- Implementing machine learning techniques that can identify the food type in the image of a food post automatically.
- Allowing users to follow other users.
- Embedding Google Maps within the food post.
- Allowing users to view the past posts they viewed previously (browsing history).
- Home
- Requirements
- Technologies
- Project management strategy
- Tasks breakdown
- Member contributions
- Meeting minutes
- API endpoints summary
- Users
-
Create a new user :
POST /api/users/
-
Get a single user :
GET /api/users/:id
-
Get a single user (firebase ID) :
GET /api/users/firebase/:id
-
Update a user:
PUT /api/users/:id
-
Create a new user :
- Posts
-
Get a single post
GET /api/posts/:id
-
Get a list of posts :
GET /api/posts/
-
Search for a post :
GET /api/posts/search
-
Create a new post :
POST /api/posts/
-
Like a post :
POST /api/posts/like-post
-
Unlike a post :
POST /api/posts/unlike-post
-
Upload an image for a post :
POST /api/posts/image
-
Get a single post
- Restaurant
-
Get restaurant :
GET /api/restaurants/
-
Get restaurant :