Merge pull request #322 from atkond2point0/master

Cooking Corner week 4/week 5/week6 report

content/docs/2024/CookingCorner/week4.md

@@ -0,0 +1,128 @@
+---
+title: "Week #4"
+---
+
+# **Week #4**
+
+## **External Feedback**
+
+During this week we have contacted our friends and asked them to try our app. 
+Since some of them were using physical cookbooks for the whole their experience, they were interested 
+in the alternative we have provided. 
+Most of them were not using such apps before, so we could check how easy it is to interact with our app. 
+Everyone has successfully created their accounts and tested the app. 
+In the response our team did not notice any troubles with acknowledging the main functionality and its usage.
+
+## **Testing**
+
+For the current state our team has created several test cases for whitebox manual testing of all endpoints. 
+For example, auth: testing that it is working correctly with correct data, returns 401 error if username already exists.
+For the future we are planning to prepare unit tests to exclude potentially critical errors, and also we need 
+to create CI/CD pipeline for further deployment.
+
+## **Iteration**
+
+For the current state of the project we have decided to redesign some parts of our app:
+
+### Recipe list
+
+* New version
+
+![](/2024/CookingCorner/new_recipe_list.png)
+
+### Recipe description
+
+* New version
+
+![](/2024/CookingCorner/new_recipe_desc.png)
+
+Old versions are available in the report of week 2.
+
+## **Weekly Progress Report**:
+
+### **Design**
+
+1) Designed a shimmer effect for the loading frames
+
+2) Changed the button for creation recipe and the settings button
+
+3) Created a blank recipe design panel
+
+4) Added pages for recipes creation:
+
+![](/2024/CookingCorner/new_things.png)
+
+### **Mobile**
+
+1) Implemented search screen
+
+2) Implemented profile screen
+
+3) Implemented detailed recipe screen
+
+4) Implemented shimmer effect for loading
+
+5) Implemented ripple effect on click
+
+6) Added password visibility
+
+7) Implemented auth API
+
+**Result: https://www.youtube.com/watch?v=UdwPkTBcEIk**
+
+### **Backend**
+
+1) Fixed bugs with some endpoints
+
+2) Added endpoints for my recipes page, for favourites and for private recipes
+
+3) Improved recipes endpoints, add additional endpoints such as get_by_tag, get_by_category
+
+4) Deployed backend part (used Yandex Cloud for that)
+
+5) Started working with integration of Llama3 using Ollama
+
+### **Frontend**:
+
+1) Added a filter panel to the home page
+
+2) Connected the backend
+
+3) Added recipe upload processing
+
+4) Added error handling when loading recipes
+
+5) Connected registration and authorization to the backend
+
+## **Challenges & Solutions**
+
+1) connection with frontend (CORS problems) - fixed
+
+2) integration of AI (Llama3 in particular) - for now in progress
+
+3) deployment problems (somehow someone get access to our database, so we need to fix issues with security) - security
+fixes are in progress
+
+## **Conclusions & Next Steps**
+
+For the next week our team is planning to:
+
+1) Integrate API for recipes management
+
+2) Implement error handling and UI for stubs
+
+3) Connect to mock web server and implementing UI tests
+
+4) Design pages for the AI recipes import
+
+5) Implements Tag selection and creation
+
+6) Make adjustments in interactive functionalities
+
+7) Fully integrate Llama3
+
+8) Continue to improve existing endpoints and creating needed
+
+9) Fix problems with security of the remote server
+
+10) Write unit tests for backend (at least for some endpoints)

content/docs/2024/CookingCorner/week5.md

@@ -0,0 +1,154 @@
+---
+title: "Week #5"
+---
+
+# **Week #5**
+
+## **Feedbacks**
+
+**Feedback collection plan**
+
+* Create a questionnaire for collecting the feedback
+
+* Ask people who can help personnaly
+
+**Conducted user surveys or feedback sessions**
+
+Our team members have sent a questionnaire to our course chat and asked several friends in real life to check the design and performance of the current state of the application
+
+
+**Analyzing feedback, identifying and prioritizing issues**
+
+Results of the questionnaire:
+
+![](/2024/CookingCorner/q1.png)
+
+![](/2024/CookingCorner/q2.png)
+
+![](/2024/CookingCorner/q3.png)
+
+![](/2024/CookingCorner/q4.png)
+
+![](/2024/CookingCorner/q5.png)
+
+![](/2024/CookingCorner/q6.png)
+
+![](/2024/CookingCorner/q7.png)
+
+![](/2024/CookingCorner/q8.png)
+
+Overall users were satisfacted by the model of the app, hovewer, we had some feedback that granted our team several useful ideas for application performance improvement:
+
+* Creation of notifications about every next step to accomplish during the cooking process
+
+* Segregation of the favorite recipes into another app activity "favorites"
+
+## **Roadmap**:
+
+The roadmap for several month after creating MVP implies development of next features:
+
+1) Notification system - user will be able to receive notifications about when to start/finish each step in the preparation of the recipe
+
+2) Advanced recipe search - search not only by name/category, but additionally by some words in description, maybe search with correction of mistakes user make while he/she writes something using their keyboard
+
+3) Recommendation system - this system will show user recipes based on their recent searches and their own created recipes
+
+4) System of comments under a recipe - will allow not only rate a recipe, but communicate with other users to know some specific information about recipe and how to cook it
+
+5) AI generation recipes preview image by its name - sometimes users are lazy to search or make a photo of some recipe, so AI can generate image based on the name of the recipe
+
+## **Weekly Progress Report**:
+
+### **Design**
+
+1) Added panes related to AI recipes import functions
+
+2) Added functions to user account, edit and log out
+
+3) Made adjustments in ingredients list of recipe panel
+
+4) Created snackbar templates for future use in case of tokens missing
+
+### **Mobile**
+
+1) Auth API review + implementation + integration
+
+2) Global Event Repository implementation (logout, snackbar and error handling) + Token Interactor implementation
+
+3) Insecure connection fix
+
+4) Recipe kebab menu implementation
+
+5) Import screen implementation
+
+6) Shadow and ripple effects improves
+
+7) Detailed recipe UI updates
+
+8) Recipe API + Recipe Repository + DI module
+
+9) Integration of Recipe Repository to Home & Search components
+
+### **Backend**
+
+1) Fixed bugs with endpoints
+
+2) Corrected responses for get-recipe endpoints (all of them)
+
+3) Fixed issues with security on the server
+
+4) Started working with uploading/downloading images
+
+5) Continued working with Llama3
+
+6) Started writing unit tests
+
+### **Frontend**
+
+1) Added logic for profile edit
+
+2) Added page for upload a recipe from url
+
+3) Added skeleton loading for all the pages
+
+4) Displaying recent recipes
+
+5)  Displaying best rated recipes
+
+6) Adding new recipe using recipe form
+
+7) Add logic for publishing recipe (if it is private)
+
+### **Challenges & Solutions**
+
+During this week we got some troubles with connection backend endpoints and frontend requests. Problem was solved after a discussion between developers.
+
+### **Conclusions & Next Steps**
+
+1) Finish Implementing tag creation and selection
+
+2) Implement functions to add images for recipe steps in manual recipe creation
+
+3) Add filtering functionality for buttons
+
+4) Create recipe / edit recipe screen implementation
+
+5) Continue to review & integrate APIs
+
+6) Add logic for deleting  recipe (if the user is a recipe author)
+
+7) Add logic for editing recipe (if the user is a recipe author)
+
+8) Fix bug with button in home page(Add to your recipes)
+
+9) Fix bug when click on button in recipe card it redirect to recipe page
+
+10) Search using search bar in search page
+
+11) Integrate images to endpoints with recipe and user
+
+12) Get some progress with LLama3
+
+13) Continue fixing bugs and improve backend overall
+
+14) Continue writing tests

content/docs/2024/CookingCorner/week6.md

@@ -0,0 +1,105 @@
+---
+title: "Week #6"
+---
+
+# **Week #6**
+
+## **Presentation**:
+
+{{< embed-pdf url="/2024/CookingCorner/CookingCorner_presentation.pdf" >}}
+
+## **Weekly Progress Report**:
+
+### **Design**
+
+1) Changed the design of ingredient panels and their interactions
+
+2) Reworked the interface of add panels
+
+3) Changed the filter icons
+
+4) Added design for cases of empty content panels
+
+5) Added Rating functionality 
+
+6) Added display of additional information about the recipe
+
+7) Implemented functions to add images for recipe steps in manual recipe creation
+
+### **Mobile**
+
+1) Recipe API integration for search, favourites, publish, delete, get by id
+
+2) Global Events refactoring
+
+3) Recipe Editor feature
+
+4) Category API implementation
+
+5) Immutable List Serializer fix
+
+6) Tag API implementation
+
+7) Recipe own status fix
+
+8) Kebab menu items fix
+
+9) Snackbar events collection fix
+
+10) Empty item screens placeholder
+
+11) Rating implementation
+
+### **Backend**
+
+1) Integrated llama3 for importing recipes from the url
+
+2) Fixed bugs with some endpoints
+
+3) Wrote tests for recipes (not for all recipe endpoints for now)
+
+4) Started working with images using yandex s3 bucket
+
+### **Frontend**
+
+1) Added logic for editing recipe
+
+2) Adding steps and ingredients to the recipe creation form
+
+3) Added placeholders for search and home page
+
+4) Search for recipes using search bar in search page
+
+5) Autocomplete form for recipe creation/editing
+
+6) Added the ability to add a review for a recipe
+
+### **Challenges & Solutions**
+
+1) Integration of llama, writing correct prompt for it and parse result data
+
+2) Working with images (using s3 bucket)
+
+### **Conclusions & Next Steps**
+
+1) Generate request + navigation to recipe editor
+
+2) Error stubs
+
+3) Favourites request + integration
+
+4) Image picker
+
+5) Pull-to-refresh
+
+6) Profile editor screen
+
+7) Clean up the details
+
+8) Fix experimental features
+
+9) Finish writing tests
+
+10) Finish working with images
+
+11) Fix bugs and improve endpoints