System Requirement Specification V1
For the system FridgeToPlate, the User stories would be from the perspective of the end-user.
The end-user in this regard would be the actor that will be using the application as per the business requirements. That is, for the purposes of generating a recipe from the food ingredients available within their inventory.
-
The user authenticates their identity using the Authentication subsystem depending on if they have already registered their details on the system (Login functionality) or if they are creating a new account (Signup functionality)
-
Upon successful authentication they will be granted access to the rest of the system. Wherein they would be able to edit their preferences and available ingredients using the Profile Management subsystem as well as the Recommendation management subsystem.
-
The user would also be able to get generic recommendations not based on their available ingredients. As well as use the Recommendation Management subsystem to perform a step-by-step process to generate a recipe based on their preferences as well as the available ingredients.
-
Upon the successful generation of a set of tailored recipes, the user can then click the recipe to start the process of preparing the recipe or save it to their profile to do so at a later time or share.
As per use case diagrams, the user stories would be as follows for each subsystem:
- As an end user, I would like to be able to sign up on the platform so that I can have my credentials and preferences stored on the system and access them when I use the system.
- As an end user, I would like to be able to login on the platform so that I can access my credentials and preferences stored on the system when I use it.
- As an end user, I would like to be able to logout from my profile on the platform so that I can have my credentials and preferences securely stored on the system and access them when I next use the system.
-
As an end user, I would like to be able to view my favorite recipes so that I can access them whenever convenient for me.
-
As an end user, I would like to be able to edit my personal preferences so that I can have a personalized experience using the application.
-
As an end user, I would like to be able to edit my user details so that I can have my credentials up to date with my current details.
-
As an end user, I would like to be able to add ingredients available in my inventory so that I can be able to get recipes that are tailored to my available ingredients.
-
As an end user, I would like to be able to get suggested recipes based on my preferences and ingredients so that I can prepare the recipe or save it for later should I wish.
-
As an end user, I would like to be able to filter suggested recipes so that I can better choose recipes based on other criteria.
-
As an end user, I would like to be able to add a custom recipe to the platform so that I can share my recipe with other users and explore other users’ recipes.
-
As an end user, I would like to be able to add and edit recipe steps so that I can instruct other users how to prepare the recipe.
-
As an end user, I would like to be able to upload recipe images to accompany custom recipes so that I can show other user’s the intended outcome of the recipe.
-
Authentication:
- Sign up
- Login
- Logout
- Forgot password
-
Profile Management:
- View favourited recipes
- Edit user preferences
- Edit user details
-
Recommendation Management:
- Add/edit search ingredients
- Display recipes that have specified ingredients
- Display recipes that have one more ingredient than specified
- Filter recommended recipes
-
Creation Management:
- Add/edit recipe ingredients
- Add/edit recipe steps
- Add/edit recipe images
-
Search Management:
- Search by recipe categories
- Search by name
- Show popular recipe searches
-
Recipe Management:
- Add recipe review
- View recipe ingredients, images, and steps
- Favourite recipe
- Performance: Responsive for most user devices
- Security: Data stored securely and encrypted where necessary
- Privacy: The app must adhere to privacy regulations
- Availability: Minimal downtown
- Reliability: All actions performed by the user perform the results intended
- Usability: Natural user experience, where new users easily understand the application
- Maintainability: The app should be modular for easy updates and modifications
- Scalability: Able to handle a high volume of concurrent users without slowdown
- Compatibility: Usable across most user devices
- Observer Pattern: This pattern is used to model the changing state of the Profile state, toalert necessary parties affected by the Profile state.
- Command Pattern: This pattern is used to model 2 sub-system, namely: (1) Authentication and (2) Recipe Recommendation sub-systems
- Strategy Pattern: This pattern is used to model the Search sub-syste; being able to search by different type of methods
- Factory Method Pattern: Used to model the creation of recipes.
- State Pattern: This pattern is used in conjuction with the Factory Pattern to know for which dietary plan to create a recipe; The states are then the various dietary plans
- Decorator Pattern: This model the functionality of Review and favourites; these are the addons added as the recipes are viewed or displayed
- Proxy Pattern: This pattern is used to model the manner of access to the database, which is through the APIs
- Façade Pattern: This provides are gentle user interface and makes the user experience seamless.
- Singleton Pattern: This is used to model the Database; only a single instance of the database should be running when the system is operational
- Memento Pattern: This pattern is used to model the persistence of data to the database and how such is handled.
