Documentation

README.md

@@ -1,48 +1,67 @@
-# [your app name here]
+# PAWmodoro :3
 
 CodePath WEB103 Final Project
 
-Designed and developed by: [your names here]
+Designed and developed by: Grecia Osorio, Brandon Budhan, Divya Ganesh, Lan Doam
 
 🔗 Link to deployed app:
 
 ## About
+Pawmodoro is a gamified study timer experience utilizing the Pomodoro technique!
 
 ### Description and Purpose
 
-[text goes here]
+In Pawmodoro, the player has a loyal, energetic pet. During study sessions, their pet will play, and during breaks, they come back with rewards! The player can use these rewards and resources to obtain items, allowing them to obtain more items, decorations, and upgrade their pet's energy. 
+
+Pawmodoro is built to gamify the Pomodoro Technique, creating a satisfying balance of productivity and entertainment. Users have one more thing to look forward to during their breaks, and allows them to romanticize the work they do!
 
 ### Inspiration
 
-[text goes here]
+Pawmodoro was inspired by the desire to have a more entertaining studying/working experience. Finding joy and aesthetic pleasure in work results in increased productivity, and a more fulfilling experience. By gamifying productivity, players will look forward to the ways Pawmodoro rewards them for working hard (and taking breaks)!
 
 ## Tech Stack
 
-Frontend:
+Frontend: React, Material UI
 
-Backend:
+Backend: Express, PostgreSQL
 
 ## Features
 
-### [Name of Feature 1]
+### Daily Task Tracker
+
+Keep your goals organized in one place. Easily add, update, and check off your daily to-dos so you always know exactly what you need to tackle next.
+
+[gif goes here]
+
+### Flexible Focus Timer
+
+Stay in the zone with a timer that adapts to your workflow. Finish a task early? Seamlessly swap to your next to-do item mid-session without losing your momentum or having to restart the clock.
 
-[short description goes here]
+[gif goes here]
+
+### Custom Timer Profiles
+
+Work your way by setting up custom work and break intervals. Whether you want a quick 15-minute sprint or a 50-minute deep dive, you're in control—and the longer you choose to focus, the bigger your coin reward will be!
 
 [gif goes here]
 
-### [Name of Feature 2]
+### Earn Coins While You Work
 
-[short description goes here]
+Turn your productivity into playtime! Get instant coin rewards just for checking off quick tasks, and earn massive payouts for successfully completing uninterrupted focus sessions.
 
 [gif goes here]
 
-### [Name of Feature 3]
+### The Paw-Mart Shop
 
-[short description goes here]
+Treat yourself (and your pet) with some stylish new furniture, rugs, and accessories using your coins! You can also buy various appearnaces for your pet to play in.
 
 [gif goes here]
 
-### [ADDITIONAL FEATURES GO HERE - ADD ALL FEATURES HERE IN THE FORMAT ABOVE; you will check these off and add gifs as you complete them]
+### Customize Your Cat's Room
+
+Create the perfect cozy space for your virtual pet. Mix and match the items you've purchased to decorate the room, instantly seeing your new design come to life on your dashboard.
+
+[gif goes here]
 
 ## Installation Instructions
 

milestones/milestone1.md

@@ -6,27 +6,28 @@ This document should be completed and submitted during **Unit 5** of this course
 
 This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets.
 
-- [ ] Read and understand all required features
-  - [ ] Understand you **must** implement **all** baseline features and **two** custom features
-- [ ] In `readme.md`: update app name to your app's name
-- [ ] In `readme.md`: add all group members' names
-- [ ] In `readme.md`: complete the **Description and Purpose** section
-- [ ] In `readme.md`: complete the **Inspiration** section
-- [ ] In `readme.md`: list a name and description for all features (minimum 6 for full points) you intend to include in your app (in future units, you will check off features as you complete them and add GIFs demonstrating the features)
-- [ ] In `planning/user_stories.md`: add all user stories (minimum 10 for full points)
-- [ ] In `planning/user_stories.md`: use 1-3 unique user roles in your user stories
-- [ ] In this document, complete all thre questions in the **Reflection** section below
+- [x] Read and understand all required features
+  - [x] Understand you **must** implement **all** baseline features and **two** custom features
+- [x] In `readme.md`: update app name to your app's name
+- [x] In `readme.md`: add all group members' names
+- [x] In `readme.md`: complete the **Description and Purpose** section
+- [x] In `readme.md`: complete the **Inspiration** section
+- [x] In `readme.md`: list a name and description for all features (minimum 6 for full points) you intend to include in your app (in future units, you will check off features as you complete them and add GIFs demonstrating the features)
+- [x] In `planning/user_stories.md`: add all user stories (minimum 10 for full points)
+- [x] In `planning/user_stories.md`: use 1-3 unique user roles in your user stories
+- [x] In this document, complete all the questions in the **Reflection** section below
 
 ## Reflection
 
 ### 1. What went well during this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+<!-- [👉🏾👉🏾👉🏾 your answer here] -->
+Our group set up time to meet, where we laid out all our project ideas and discussed which ones we were interested in working on. Ultimately, we were all noticably passionate about Pawmodoro, and had active discussion about possible features. We also discussed different libraries and tools we could use to help during development, and we're all overall excited to collaborate on this project!
 
 ### 2. What were some challenges your group faced in this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+The first major challenge was coming to an agreement about an idea. We had around 4-5 ideas in mind, but after discussing each, we quickly came to the conclusion that Pawmodoro was a good fit for our group. The next challenge was narrowing down a realistic feature set. We had many exciting and creative ideas, but we recognized that not all of them are feasible given our resources and allotted time. 
 
 ### 3. What additional support will you need in upcoming units as you continue to work on your final project?
 
-[👉🏾👉🏾👉🏾 your answer here]
+Practice with advanced database concepts, such as joining, and managing multiple tables with foreign will be helpful to us given the scope of our project. We're projected to be managing multiple tables at once, and our database schema needs to be coherent and well thought-out for our app to function the way we envision.

milestones/milestone2.md

@@ -6,24 +6,24 @@ This document should be completed and submitted during **Unit 6** of this course
 
 This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets.
 
-- [ ] In `planning/wireframes.md`: add wireframes for at least three pages in your web app.
-  - [ ] Include a list of pages in your app
-- [ ] In `planning/entity_relationship_diagram.md`: add the entity relationship diagram you developed for your database.
-  - [ ] Your entity relationship diagram should include the tables in your database.
-- [ ] Prepare your three-minute pitch presentation, to be presented during Unit 7 (the next unit).
-  - [ ] You do **not** need to submit any materials in advance of your pitch.
-- [ ] In this document, complete all three questions in the **Reflection** section below
+- [x] In `planning/wireframes.md`: add wireframes for at least three pages in your web app.
+  - [x] Include a list of pages in your app
+- [x] In `planning/entity_relationship_diagram.md`: add the entity relationship diagram you developed for your database.
+  - [x] Your entity relationship diagram should include the tables in your database.
+- [x] Prepare your three-minute pitch presentation, to be presented during Unit 7 (the next unit).
+  - [x] You do **not** need to submit any materials in advance of your pitch.
+- [x] In this document, complete all three questions in the **Reflection** section below
 
 ## Reflection
 
 ### 1. What went well during this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+Everyone in our group was able to get together to work on the wireframes simultaneously. This allowed us to dicuss and come to mutual decisions in the visual structure of our app, which will be a great help during development!
 
 ### 2. What were some challenges your group faced in this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+Our group didn't run into many challenges during this unit. During the wireframes, there were some pages that were tricky to structure, as there were many possibilities, but by bouncing ideas off of one another and giving constructive feedback, we were able to mutually decide on a stucture.
 
 ### 3. What additional support will you need in upcoming units as you continue to work on your final project?
 
-[👉🏾👉🏾👉🏾 your answer here]
+Feedback on our pitch, wireframe, and entity relationship diagram will provide us with helpful perspective and considerations that we may not have made! This perspective will greatly aid the development of our app, and ensure it meets development and user expectations.

milestones/milestone3.md

@@ -8,34 +8,35 @@ This unit, be sure to complete all tasks listed below. To complete a task, place
 
 You will need to reference the GitHub Project Management guide in the course portal for more information about how to complete each of these steps.
 
-- [ ] In your repo, create a project board. 
+- [x] In your repo, create a project board. 
   - *Please be sure to share your project board with the grading team's GitHub **codepathreview**. This is separate from your repository's sharing settings.*
-- [ ] In your repo, create at least 5 issues from the features on your feature list.
-- [ ] In your repo, update the status of issues in your project board.
-- [ ] In your repo, create a GitHub Milestone for each final project unit, corresponding to each of the 5 milestones in your `milestones/` directory. 
-  - [ ] Set the completion percentage of each milestone. The GitHub Milestone for this unit (Milestone 3 - Unit 7) should be 100% completed when you submit for full points.
-- [ ] In `readme.md`, check off the features you have completed in this unit by adding a ✅ emoji in front of the feature's name.
-  - [ ] Under each feature you have completed, include a GIF showing feature functionality.
-- [ ] In this documents, complete all five questions in the **Reflection** section below.
+- [x] In your repo, create at least 5 issues from the features on your feature list.
+- [x] In your repo, update the status of issues in your project board.
+- [x] In your repo, create a GitHub Milestone for each final project unit, corresponding to each of the 5 milestones in your `milestones/` directory. 
+  - [x] Set the completion percentage of each milestone. The GitHub Milestone for this unit (Milestone 3 - Unit 7) should be 100% completed when you submit for full points.
+- [x] In `readme.md`, check off the features you have completed in this unit by adding a ✅ emoji in front of the feature's name.
+  - [x] Under each feature you have completed, include a GIF showing feature functionality.
+  - *NOTE: No milestone features have been scheduled for Milestone 3 as of now. All milestone features have been slated for Milestone 4 or 5*
+- [x] In this documents, complete all five questions in the **Reflection** section below.
 
 ## Reflection
 
 ### 1. What went well during this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+Our group met like usual this week, and getting started felt really smooth. We did a good job splitting up early tasks so everyone had clear ownership, and that helped us keep momentum right away. Some teammates also met outside our main meeting to walk through Material UI setup together, which made frontend setup a lot easier for the team overall. We also stayed organized with our board and milestone tracking, so project management felt much more under control this unit.
 
 ### 2. What were some challenges your group faced in this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+We did not run into any major blockers, but we did spend time figuring out how to scope our tasks in the best way. A big challenge was deciding when an issue should stay broad as a feature and when it should be broken down into smaller tasks. That came up a lot for backend and data work, where dependencies are not always obvious at first. Even though it was not a huge problem, it was something we had to be thoughtful about as a team.
 
 ### Did you finish all of your tasks in your sprint plan for this week? If you did not finish all of the planned tasks, how would you prioritize the remaining tasks on your list?
 
-[👉🏾👉🏾👉🏾 your answer here]
+We finished the main Unit 7 sprint goals we planned for, especially around project setup and organization. Most feature-heavy implementation was intentionally planned for later milestones, so the remaining work is expected carryover and not really missed work. For prioritization, we plan to split the features up according to individual members' interest and time commitment such that no member is fully dependent on the other for a given milestone, which will make it easier for team members to work in parallel.
 
 ### Which features and user stories would you consider “at risk”? How will you change your plan if those items remain “at risk”?
 
-[👉🏾👉🏾👉🏾 your answer here]
+The most at-risk features are the ones that depend on both frontend and backend being in sync, like earning coins while working, table integration across core data models, and the user profile flow. These are riskier because they rely on multiple moving parts like API routes, schema decisions, and coordinated implementation. If these stay at risk, we will split them into smaller vertical slices, agree on API contracts first, and focus on shipping core functionality before polish. We can also push some non-blocking visual enhancements later if needed so we protect the main user flow.
 
 ### 5. What additional support will you need in upcoming units as you continue to work on your final project?
 
-[👉🏾👉🏾👉🏾 your answer here]
+Ongoing feedback during development would be super helpful for our team. More perspectives on what is working well and what feels unclear would help us make better decisions earlier and avoid rework later. We would especially benefit from feedback on app flow, backend structure, and feature usability as we start integrating everything. Having that support while we are still building will make it easier to improve quality before final submission.

planning/entity_relationship_diagram.md

@@ -4,14 +4,101 @@ Reference the Creating an Entity Relationship Diagram final project guide in the
 
 ## Create the List of Tables
 
-[👉🏾👉🏾👉🏾 List each table in your diagram]
+<!-- *[👉🏾👉🏾👉🏾 List each table in your diagram]* -->
+* USERS
+* CATS
+* POMODORO_PROFILES
+* INVENTORY
+* SHOP_ITEMS
+* TASKS
 
 ## Add the Entity Relationship Diagram
 
-[👉🏾👉🏾👉🏾 Include an image or images of the diagram below. You may also wish to use the following markdown syntax to outline each table, as per your preference.]
+<!-- [👉🏾👉🏾👉🏾 Include an image or images of the diagram below. You may also wish to use the following markdown syntax to outline each table, as per your preference.]
 
 | Column Name | Type | Description |
 |-------------|------|-------------|
 | id | integer | primary key |
 | name | text | name of the shoe model |
-| ... | ... | ... |
+| ... | ... | ... | -->
+
+<img src="./assets/ERD.png"/>
+
+---
+```
+erDiagram
+  USERS {
+    string uid PK
+    string name
+    string profilePicture
+    int coins
+    datetime createdAt
+  }
+
+  CATS {
+    int id PK
+    string userId FK
+    string name
+    string image
+    int energy
+  }
+
+  POMODORO_PROFILES {
+    int id PK
+    string userId FK
+    string name
+    int timeOn
+    int timeBreak
+    int timeLongBreak
+    boolean isDefault
+  }
+
+  STUDY_SESSIONS {
+    int id PK
+    string userId FK
+    int profileId FK
+    datetime startTime
+    datetime endTime
+    int coinsEarned
+  }
+
+  SHOP_ITEMS {
+    int id PK
+    string name
+    string image
+    string category
+    int price
+  }
+
+  INVENTORY {
+    int id PK
+    string userId FK
+    int shopItemId FK
+    int quantity
+    boolean equipped
+    datetime acquiredAt
+  }
+
+  TASKS {
+    int id PK
+    string userId FK
+    string title
+    boolean completed
+    datetime createdAt
+    datetime completedAt
+  }
+
+  %% Relationships
+  USERS ||--|| CATS : has
+  USERS ||--o{ POMODORO_PROFILES : saves
+  USERS ||--o{ INVENTORY : owns
+  SHOP_ITEMS ||--o{ INVENTORY : appears_in
+  USERS ||--o{ TASKS : tracks
+
+%% || = exactly one
+%% o{ = zero or many
+%% |{ = one or many
+%% o| = zero or one
+%% PK = Primary Key
+%% FK = Foreign Key
+```

planning/user_stories.md

@@ -6,8 +6,32 @@ Reference the Writing User Stories final project guide in the course portal for
 
 [👉🏾👉🏾👉🏾 Include at least at least 1, but no more than 3, user roles.]
 
+1. Player
+2. Student
+3. Worker
+
 ## Draft User Stories
 
 [👉🏾👉🏾👉🏾 Include at least at least 10 user stories in this format:]
 
-1. As a [user role], I want to [what], so that [why].
+<!-- 1. As a [user role], I want to [what], so that [why]. -->
+
+1. As a player, I want to create an account and profile so that my information persists across sessions and devices.
+
+2. As a player, I want to customize my pomodoro splits so that I can have flexibility in my working sessions.
+
+3. As a player, I want to swap my active task without stopping the countdown timer so that I can maintain my work momentum if I finish an assignment early.
+
+4. As a player, I want to spend my earned coins on items in the Paw-Mart so that I can personalize my virtual cat's room.
+
+5. As a student, I want to edit tasks before or during my splits so that I can personalize them if I change my mind about the task.
+
+6. As a student, I want different pages for the Paw-Mart and the Pawmodoro clock so I am not distracted by the possible purchases while studying.
+
+7. As a student who struggles to focus in noisy or distracting environments, I want to choose from a curated list of white noise and ambient sounds that I can adjust in volume, so that I can stay focused throughout my Pomodoro sessions.
+
+8. As a worker, I want to a list that keep tracks of my completed task so that I can manage my weekly accomplishments.
+
+9. As a student, I want a graph that analyze my study habits so that I know which time of day is best for studying.
+
+10. As a student, I want to customize the aesthetics of my workspace to my liking so that I enjoy my studying more

planning/wireframes.md

@@ -4,18 +4,20 @@ Reference the Creating an Entity Relationship Diagram final project guide in the
 
 ## List of Pages
 
-[👉🏾👉🏾👉🏾 List the pages you expect to have in your app, with a ⭐ next to pages you have wireframed]
+1. ⭐ Home Page
+2. ⭐ Shop/Inventory Page
+3. ⭐ User Profile Page
 
-## Wireframe 1: [page title]
+## Wireframe 1: Home Page
 
-[👉🏾👉🏾👉🏾 include wireframe 1]
+<img src="./assets/homePage.png">
 
-## Wireframe 2: [page title]
+## Wireframe 2: Shop Page
 
-[👉🏾👉🏾👉🏾 include wireframe 2]
+<img src="./assets/shopInvPage.png">
 
-## Wireframe 3: [page title]
+## Wireframe 3: User Profile Page
 
-[👉🏾👉🏾👉🏾 include wireframe 3]
+<img src="./assets/userProfilePage.png">
 
-[👉🏾👉🏾👉🏾 include more wireframes as desired]
+