user stories

README.md

@@ -1,49 +1,108 @@
-# [your app name here]
+# 🦸‍♂️ HabitHero
 
-CodePath WEB103 Final Project
+### CodePath WEB103 Final Project
 
-Designed and developed by: [your names here]
+**Designed and developed by:**  
+Ricardo Beale, Vitaliy Prymak, Om Patki
 
-🔗 Link to deployed app:
+🔗 **Link to deployed app:** [HabitHero](https://habitss-cxf1.onrender.com)
 
-## About
+---
 
-### Description and Purpose
+## 🧩 About
 
-[text goes here]
+### 📝 Description and Purpose
+HabitHero is a fullstack web app that helps users build and track positive habits through small daily goals.  
+Each completed habit helps the user’s “hero” grow stronger, motivating consistency and self-improvement.  
+The app allows users to add, edit, and delete habits, view progress, and earn virtual achievements for streaks.
 
-### Inspiration
+### 💡 Inspiration
+We were inspired by apps like **Habitica** and **Duolingo** that combine productivity with fun.  
+Many people struggle to stay consistent, so we wanted to create something that makes tracking habits more engaging — turning discipline into a game.
 
-[text goes here]
+---
 
-## Tech Stack
+## ⚙️ Tech Stack
+- **Frontend:** React, React Router, Tailwind CSS  
+- **Backend:** Express.js, Node.js, PostgreSQL
 
-Frontend:
+---
+## 🌟 Basic Features
+### 🪪 Authentication ✅
+Users will be able to create an account, log in, and securely access their personalized habit data.
 
-Backend:
+![](gifs/Authentication.gif)
 
-## Features
+### 🧠 Habit Dashboard with Habit Cards ✅
+Users can view all their habits in one place with progress tracking and streak counts. Each habit will be displayed as a card showing its name, progress, category, and completion status, allowing users to easily track and manage their habits.
 
-### [Name of Feature 1]
+![](gifs/Habit-Dashboard.gif)
 
-[short description goes here]
+### ➕ Add / Edit / Delete Habits ✅
+Users can create new habits, update them, or remove them easily from their dashboard.
 
-[gif goes here]
+![](gifs/Add-Edit-Delete-Habits.gif)
 
-### [Name of Feature 2]
+---
+## 🔥 Bonus (Stretch Features)
 
-[short description goes here]
+### 💬 Motivational Quotes ✅
+Displays daily motivational quotes to encourage users and help maintain consistent habit-building momentum.
 
-[gif goes here]
+![](gifs/Motivational-Quotes.gif)
 
-### [Name of Feature 3]
+### 📊 Progress Bar and Streak Tracking ✅
+Visual indicators show how close users are to completing each habit and how long they’ve kept a streak going, motivating them to continue.
 
-[short description goes here]
+![](gifs/Progress-Bar-and-Streak-Tracking.gif)
 
-[gif goes here]
+### 🤖 AI Habit Coach Chatbot ✅
+An AI-powered assistant that guides users, answers questions, and offers personalized habit-building tips or suggestions.
 
-### [ADDITIONAL FEATURES GO HERE - ADD ALL FEATURES HERE IN THE FORMAT ABOVE; you will check these off and add gifs as you complete them]
+![](gifs/AI-Habit-Coach-Chatbot.gif)
 
-## Installation Instructions
+### ✍️ AI Mood Reflection and Journaling ✅
+Allows users to log their mood and daily reflections. AI summarizes, analyzes patterns, and provides emotional or habit-based insights.
 
-[instructions go here]
+![](gifs/AI-Mood-Reflection-and-Journaling.gif)
+
+### ⚡ AI-Powered Autocomplete for Habit Names ✅
+When users type a new habit, the system predicts and suggests common habit names to make creation faster and easier.
+
+![](gifs/AI-Powered-Autocomplete.gif)
+
+### 🎨 AI-Powered Habit Naming and Description Generator ✅
+Generates creative, well-written habit names and descriptions based on user goals, helping them articulate habits more effectively.
+
+![](gifs/AI-Powered-Habit-Naming.gif)
+
+### 🔥 Accountability Heatmap ✅
+A visual heatmap showing activity levels over time, helping users see patterns in consistency and identify strong or weak periods in their habit-building journey.
+
+![](gifs/Accountability-Heatmap.gif)
+
+---
+
+## 💻 Installation Instructions
+
+### 1. Clone the repository
+```bash
+git clone https://github.com/your-team/habithero.git
+```
+### 2. Install dependencies
+```bash
+cd habithero
+npm install
+cd client
+npm install
+```
+### 3. Create and seed the PostgreSQL database
+```bash
+npm run db:reset
+```
+### 4. Run both servers
+```bash
+npm run dev
+```
+### 5. Open the app
+- Visit: http://localhost:5173

milestones/milestone1.md

@@ -6,27 +6,24 @@ 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 thre questions in the **Reflection** section below
 
 ## Reflection
 
-### 1. What went well during this unit?
+1. What went well during this unit?
+👉🏾 We brainstormed and agreed quickly on a clear idea — HabitHero — a productivity and motivation app that helps users build daily habits. Our group collaborated well to define the main features, roles, and responsibilities. Everyone contributed ideas for the user stories and feature list.
 
-[👉🏾👉🏾👉🏾 your answer here]
+2. What were some challenges your group faced in this unit?
+👉🏾 It was a bit hard to narrow down which features to include since there are so many possible ideas for a habit tracker. We also had to make sure all required baseline features fit naturally into the project. Setting up the shared GitHub repo and assigning tasks clearly took some coordination time.
 
-### 2. What were some challenges your group faced in this unit?
-
-[👉🏾👉🏾👉🏾 your answer here]
-
-### 3. What additional support will you need in upcoming units as you continue to work on your final project?
-
-[👉🏾👉🏾👉🏾 your answer here]
+3. What additional support will you need in upcoming units as you continue to work on your final project?
+👉🏾 We may need extra help with database relationships (especially many-to-many) and setting up deployment on Render. Some of us also want guidance on connecting the backend API with React efficiently.

milestones/milestone2.md

@@ -6,24 +6,22 @@ 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]
+Our team did a great job organizing our ideas and visualizing the structure of our project. Creating the entity relationship diagrams helped us clearly understand how our database should be built. The wireframing process also went smoothly since several team members were familiar with Figma, which made it easier to design and collaborate efficiently.
 
 ### 2. What were some challenges your group faced in this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+One of the main challenges we faced was figuring out how to structure our data and connect the different parts of our database properly. It took some trial and error to make sure everything worked together logically. We also had to make sure everyone was on the same page about the project’s overall direction.
 
 ### 3. What additional support will you need in upcoming units as you continue to work on your final project?
-
-[👉🏾👉🏾👉🏾 your answer here]
+Moving forward, we might need more support with backend integration, especially how to connect our database to the front end of the website. Some guidance on best practices for implementing user authentication, managing data relationships, and deploying the project would also be helpful as we start to build everything out.

milestones/milestone3.md

@@ -8,34 +8,34 @@ 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.
+- [X] In this documents, complete all five questions in the **Reflection** section below.
 
 ## Reflection
 
 ### 1. What went well during this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+We were able to set up our project board, create issues, and organize everything clearly. Updating the milestones and tracking progress helped our team stay aligned and understand what still needed to be done.
 
 ### 2. What were some challenges your group faced in this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+One challenge was making sure each issue was properly connected to the project board and assigned to the correct milestone. It also took extra time for us to match features with the right categories on our board.
 
-### 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?
+### 3. 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 most tasks, but we still need to finalize the README updates and add the GIFs. We would prioritize completing the README first since it clearly shows our progress and is required for the milestone.
 
-### Which features and user stories would you consider “at risk”? How will you change your plan if those items remain “at risk”?
+### 4. 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 README documentation and GIF creation are currently at risk because they require extra time and coordination. If they remain at risk, we’ll break them into smaller tasks and complete them as individual features are finished instead of waiting until the end.
 
 ### 5. What additional support will you need in upcoming units as you continue to work on your final project?
 
-[👉🏾👉🏾👉🏾 your answer here]
+We may need support with organizing and recording feature GIFs, keeping our project board updated consistently, and making sure our pacing stays aligned with future milestones.

milestones/milestone4.md

@@ -6,29 +6,29 @@ This document should be completed and submitted during **Unit 8** of this course
 
 This unit, be sure to complete all tasks listed below. To complete a task, place an `x` between the brackets.
 
-- [ ] Update the completion percentage of each GitHub Milestone. The milestone for this unit (Milestone 4 - Unit 8) 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 document, complete all five questions in the **Reflection** section below.
+- [X] Update the completion percentage of each GitHub Milestone. The milestone for this unit (Milestone 4 - Unit 8) 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.
+- [X] In this document, complete all five questions in the **Reflection** section below.
 
 ## Reflection
 
 ### 1. What went well during this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+This unit went really well in terms of productivity and collaboration. Our basic features were already implemented, which allowed us to focus on adding multiple AI-powered stretch features such as the Habit Coach Chatbot, AI Mood Reflection, Autocomplete, and automatic habit naming. As a group, we worked efficiently, shared ideas openly, and successfully integrated a large set of advanced features into the app. Overall, the quality of the final features shows that we worked well as a team and pushed the project beyond the basic requirements.
 
 ### 2. What were some challenges your group faced in this unit?
 
-[👉🏾👉🏾👉🏾 your answer here]
+Our biggest challenge was communication around time commitments and workload. Because we didn’t always update each other on availability, some team members ended up taking on more tasks than planned while others were less involved at certain points. This created some imbalance in workload. We also had to navigate the complexity of adding multiple AI features, which required extra testing, debugging, and alignment across components.
 
 ### 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 most of the tasks in our sprint plan, especially the major AI stretch features. Any remaining small tasks like polish, UI consistency, and minor bug fixes would be prioritized by focusing first on functionality issues that affect the user experience, then on UI cleanup, and finally on optional enhancements. Our priority would be to ensure all AI features work smoothly and integrate cleanly with the dashboard and existing habit flow.
 
 ### 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 only items that might be considered “at risk” are polish-related features such as final UI refinements or minor improvements to AI responses and text generation. These don’t block core functionality but could impact the overall feel of the app if left unfinished. If they remain at risk, we would adjust our plan by reducing the scope and focus on making sure the feature works reliably rather than trying to make it perfect. Then we'd move any nice-to-have improvements into a later sprint.
 
 ### 5. What additional support will you need in upcoming units as you continue to work on your final project?
 
-[👉🏾👉🏾👉🏾 your answer here]
+Moving forward, we may need support in two areas: (1) organizing our workflow more effectively so that responsibilities and deadlines are clearer, and (2) technical guidance on optimizing our AI integrations, especially if we add more advanced functionality. Having more structured guidance for project management and occasional help with debugging AI/OpenAI API features would help us stay on track for the final project.