Proposal: DailyDive (Ansel Chang, Sharon Wu, and Kristine Guan)

.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

README.md

@@ -1,49 +1,22 @@
-# Final Project
-*Due October 13th (final day of the term)*
+DailyDive
+=========
 
-For your final project, you'll implement a web application that exhibits understanding of the course materials. 
-This project should provide an opportunity to both be creative and to pursue individual research and learning goals.
+https://dailydive-80188849a5ca.herokuapp.com/
+Video: https://www.youtube.com/watch?v=vdfbnKZRWn4&ab_channel=Ansel
 
-## General description
-Your project should consist of a complete Web application, exhibiting facets of the three main sections of the course material:
+By Ansel Chang, Sharon Wu, Kristine Guan
 
-- Static web page content and design. You should have a project that is accessible, easily navigable, and features significant content.
-- Dynamic behavior implemented with JavaScript (TypeScript is also allowed if your group wants to explore it).
-- Server-side programming *using Node.js*. Typically this will take the form of some sort of persistent data (database), authentication, and possibly server-side computation. 
-- A video (less than five minutes) where each group member explains some aspect of the project. An easy way to produce this video is for you all the groups members to join a Zoom call that is recorded; each member can share their screen when they discuss the project or one member can "drive" the interface while other members narrate (this second option will probably work better.) The video should be posted on YouTube or some other accessible video hosting service. Make sure your video is less than five minutes, but long enough to successfully  explain your project and show it in action. There is no minimum video length.
+Do you struggle in finding motivation to succeed at your goals? *DailyDive* gamifies building habits by tracking your daily successes and failures in achieving your daily habit goal. Users can create and manage an unlimited number of Habits, where red and green color-coded calendars show how well you’re doing! The satisfying click to turn the day’s square green breaks down impossible goals into daily progress, while progress bars and statistics remind you how far you’ve come since creating your Habit.
 
-## Project ideation
-Excellent projects typically serve someone/some group; for this assignment you need to define your users and stakeholders. I encourage you to identify projects that will have impact, either artistically, politically, or in terms of productivity. 
+This project was developed with the MERN stack: MongoDB for storing users and habits, Vite+React for the frontend, and Express with Node JS to handle requests between MongoDB and the frontend. We use Typescript for more maintainable code and Bootstrap for better CSS styling. DailyDive features a login/signup page where new users can create a (username, password) pair, and once logged in, users can create an unlimited number of habits, each with daily logging functionality.
 
-### Deliverables
+We faced quite a few issues in development. The first was the limited time forcing us to simplify our scope - original vision had pages for in-depth statistics and competition with other users. In addition, making a reactive calendar was a challenge, and we realized we should update the outcome color when a user clicks on a calendar day immediately on the client side, even before sending and recieving a response from the server, for better responsiveness. We faced tougher challenges along that vein, like long loading times for the user page due to lots of database polling, and learned that for a more responsive website, we'd want to do a lot of redundant calculations client-side as well to avoid the latency dealing with the server.
 
-#### Form Team (due 9/25)
-Students are will work in teams of 3-5 students for the project; teams of two can be approved with the permission of the instructor. Working in teams should help enable you to build a good project in a limited amount of time.  Use the `#project-logistics` channel in Discord to pitch ideas for final projects and/or find fellow team members as needed.
+Ansel created the Figma designs for the front end, wrote the Express NodeJS server code, and wrote boilerplate react code to send and recieve requests from the server. He also did the frontend for login/signup page and the calendar component.
 
-Teams must be in place by end of day on Sunday, September 25th. If you have not identified a team at this point, you will be assigned a team. You will be given some class time on Monday to work on your proposal, but please plan on reserving additional time outside of class as needed.
+Sharon did the frontend for the Habit page, as well as parts of the User page. She reworked parts of the original design sketches to improve UX, and created flexible and reusable React components that were reused in different parts of DailyDive. She enforced consistent Bootstrap stylings and maintained high quality UI for a responsive user experience throughout the webapp.
 
-#### Proposal (due 9/27) 
-Provide an outline of your project direction and the names of associated team members. 
-The outline should have enough detail so that staff can determine if it meets the minimum expectations, or if it goes too far to be reasonable by the deadline. Please include a general description of a project, and list of key technologies/libraries you plan on using (e.g. React, Three.js, Svelte, TypeScript etc.). Two to four paragraps should provide enough level of detail. Name the file proposal.md and submit a pull request by Tuesday, September 27th at 11:59 PM (end of day). Only one pull request is required per team.
+Kristine did the front end for parts of the User page, and provided careful feedback to improve the visual quality of the webpages.
 
-There are no other scheduled checkpoints for your project. 
 
-#### Turning in Your Project
-Submit a second PR on the final project repo to turn in your app and code. Again, only one pull request per team.
 
-Deploy your app, in the form of a webpage, to Glitch/Heroku/Digital Ocean or some other service; it is critical that the application functions correctly wherever you post it.
-
-The README for your second pull request doesn’t need to be a formal report, but it should contain:
-
-1. A brief description of what you created, and a link to the project itself (two paragraphs of text)
-2. Any additional instructions that might be needed to fully use your project (login information etc.)
-3. An outline of the technologies you used and how you used them.
-4. What challenges you faced in completing the project.
-5. What each group member was responsible for designing / developing.
-6. A link to your project video.
-
-Think of 1,3, and 4 in particular in a similar vein to the design / tech achievements for A1—A4… make a case for why what you did was challenging and why your implementation deserves a grade of 100%.
-
-## FAQs
-
-- **Can I use XYZ framework?** You can use any web-based frameworks or tools available, but for your server programming you need to use Node.js. Your client-side scripting language should be either JavaScript or TypeScript.

index.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>DailyDive</title>
+  </head>
+  <body>
+    <!-- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous"> -->
+    <link href='https://fonts.googleapis.com/css?family=Road Rage' rel='stylesheet'></link>
+    <link href='https://fonts.googleapis.com/css?family=Kavoon' rel='stylesheet'>
+    <link href='https://fonts.googleapis.com/css?family=Skranji' rel='stylesheet'>
+    <link href='https://fonts.googleapis.com/css?family=Salsa' rel='stylesheet'>
+
+
+    <div id="root"></div>
+    <script type="module" src="/src/client/main.tsx"></script>
+  </body>
+</html>

models.ts

@@ -0,0 +1,86 @@
+export enum Outcome {
+    SUCCESS = "SUCCESS",
+    FAIL = "FAIL",
+    NONE = "NONE"
+}
+
+export class HabitOutcome {
+    year: number = -1;
+    month: number = -1;
+    day: number = -1;
+    outcome: Outcome = Outcome.NONE;
+
+    constructor(year: number, month: number, day: number, outcome: Outcome) {
+        this.year = year;
+        this.month = month;
+        this.day = day;
+        this.outcome = outcome;
+    }
+
+}
+
+export class UserHabit {
+    userID: string;
+    habitID: string;
+    name: string;
+    description: string;
+    currentStreak: number;
+    numLoggedDays: number;
+    numSuccessesWeek: number;
+    percentSuccessLifetime: number;
+    numLoggedDaysWeek: number;
+
+    constructor(userID: string, habitID: string, name: string = "", description: string = "", currentStreak: number = -1, numLoggedDays: number = -1, numSuccessesWeek: number = -1, percentSuccessLifetime: number = -1, numLoggedDaysWeek: number = -1) {
+        this.userID = userID;
+        this.habitID = habitID;
+        this.name = name;
+        this.description = description;
+        this.currentStreak = currentStreak;
+        this.numLoggedDays = numLoggedDays;
+        this.numSuccessesWeek = numSuccessesWeek;
+        this.percentSuccessLifetime = percentSuccessLifetime;
+        this.numLoggedDaysWeek = numLoggedDaysWeek;
+    }
+
+    get percentSuccessWeek(): number {
+        return (this.numLoggedDaysWeek === 0) ? 0 : +(((this.numSuccessesWeek / this.numLoggedDaysWeek) * 100).toFixed(2));
+    }
+
+}
+
+export class UserInfo {
+    username: string;
+    numLoggedDays: number;
+    percentSuccessWeek: number;
+    // percentSuccessLifetime?: number;
+    percentSuccessLifetime: number;
+    habits: UserHabit[];
+
+    constructor(username: string = "", numLoggedDays: number = -1, percentSuccessWeek: number = -1, percentSuccessLifetime: number = -1, habits: UserHabit[] = []) {
+        this.username = username;
+        this.numLoggedDays = numLoggedDays;
+        this.percentSuccessWeek = percentSuccessWeek;
+        this.percentSuccessLifetime = percentSuccessLifetime;
+        this.habits = habits;
+    }
+
+}
+
+export class Day {
+    year: number = -1;
+    month: number = -1;
+    day: number = -1;
+
+    constructor(year: number, month: number, day: number) {
+        this.year = year;
+        this.month = month;
+        this.day = day;
+    }
+
+    previous(): Day {
+        let date = new Date(this.year, this.month, this.day);
+        date.setDate(date.getDate() - 1);
+        return new Day(date.getFullYear(), date.getMonth(), date.getDate());
+    }
+
+}