Balans - final project

README.md

@@ -1,13 +1,62 @@
-# Final Project
+# Balans — Energy Management App
 
-Replace this readme with your own information about your project.
+**Balans** is a mobile-first web app for people who need to manage their daily energy carefully. Inspired by Spoon Theory — a framework often used by people with chronic illness (depression, burnout etc) to describe limited energy resources — Balans helps you plan your day around how much energy you actually have, not how much you wish you had.
 
-Start by briefly describing the assignment in a sentence or two. Keep it short and to the point.
+---
 
-## The problem
+## The Problem
 
-Describe how you approached to problem, and what tools and techniques you used to solve it. How did you plan? What technologies did you use? If you had more time, what would be next?
+People living with chronic fatigue or energy-limiting conditions often struggle to plan their days in a way that respects their capacity. Traditional to-do apps treat all tasks as equal and don't account for energy cost. Balans fills that gap by letting you log your current energy, plan activities based on what drains or restores you, and reflect on patterns over time.
 
-## View it live
+---
 
-Every project should be deployed somewhere. Be sure to include the link to the deployed project so that the viewer can click around and see what it's all about.
+## Features
+
+- **Energy check-in** — Log your energy level (1–10) at the start of each day using an interactive battery visualisation
+- **Activity planner** — Add activities to your day, each tagged as energy-draining or energy-restoring, with a cost/gain value
+- **Day summary** — See a breakdown of your planned day and get a personalised tip from the mascot based on your energy balance
+- **History** — Review past days and track your energy patterns over time
+- **Custom activities** — Add your own activities (private to your account) alongside the built-in defaults
+- **Animated mascot** — EnergyBlob reacts to your energy level with different expressions and animations
+- **User accounts** — Register, log in, and keep your data private with JWT-based authentication
+
+---
+
+## Tech Stack
+
+### Frontend
+- React + Vite
+- styled-components (with CSS custom properties for theming)
+- Framer Motion (animations)
+- Zustand (global state)
+- React Router 
+- Phosphor Icons
+
+### Backend
+- Node.js + Express
+- MongoDB + Mongoose
+- bcrypt (password hashing)
+- Babel + Nodemon
+
+---
+
+## Deployment
+
+- **Frontend:** [Netlify](https://final-project-balans.netlify.app)
+- **Backend:** [Render](https://project-final-balans.onrender.com)
+
+---
+
+## What's Next
+
+- Mood tracking alongside energy levels
+- AI-powered suggestions based on your personal energy history
+- Weekly and monthly energy overview charts
+- Adding a calender to plan a week ahead
+- Checkboxes in history, to be able to check the activities you completed in the end om the day
+
+---
+
+## About the Name
+
+*Balans* is the Swedish word for balance — because the goal isn't to do more, it's to find the balance that works for you.

backend/data/seedActivities.js

@@ -0,0 +1,90 @@
+import { Activity } from "../models/Activity.js";
+
+export const defaults = [
+  // Activities that gives energy
+  {
+    name: "Promenad",
+    energyImpact: 2,
+    category: "rörelse"
+  },
+  {
+    name: "Yoga",
+    energyImpact: 3,
+    category: "rörelse"
+  },
+  {
+    name: "Träning lätt",
+    energyImpact: 1,
+    category: "rörelse"
+  },
+  {
+    name: "Meditation",
+    energyImpact: 3,
+    category: "vila"
+  },
+  {
+    name: "Powernap",
+    energyImpact: 3,
+    category: "vila",
+  },
+  {
+    name: "Umgås",
+    energyImpact: 2,
+    category: "socialt"
+  },
+  {
+    name: "Natur",
+    energyImpact: 2,
+    category: "vardag",
+  },
+
+  // Activities that takes energy. 
+  {
+    name: "Jobb",
+    energyImpact: -2,
+    category: "jobb"
+  },
+  {
+    name: "Möte",
+    energyImpact: -2,
+    category: "jobb"
+  },
+  {
+    name: "Städning",
+    energyImpact: -2,
+    category: "vardag"
+  },
+  {
+    name: "Skärmtid",
+    energyImpact: -1,
+    category: "vardag"
+  },
+  {
+    name: "Matlagning",
+    energyImpact: -1,
+    category: "vardag"
+  },
+  {
+    name: "Pendling",
+    energyImpact: -2,
+    category: "vardag"
+  },
+  {
+    name: "Handla",
+    energyImpact: -2,
+    category: "vardag"
+  },
+  {
+    name: "Träning tung",
+    energyImpact: -3,
+    category: "rörelse",
+  }
+];
+
+// Fills the database with standard activities once when the app starts. 
+export const seedActivities = async () => {
+  const count = await Activity.countDocuments();
+  if (count === 0) {
+    await Activity.insertMany(defaults);
+  }
+};

backend/middleware/authMiddleware.js

@@ -0,0 +1,16 @@
+import { User } from "../models/User.js";
+
+//This is the "safeguard" for the protected endpoints, the one that uses auth. 
+export const authenticateUser = async (req, res, next) => {
+  const user = await User.findOne({
+    accessToken: req.header("Authorization")
+  });
+  if (user) {
+    req.user = user
+    next();
+  } else {
+    res.status(401).json({
+      loggedOut: true
+    });
+  }
+}; 

backend/models/Activity.js

@@ -0,0 +1,22 @@
+import { Schema, model } from "mongoose";
+
+const activitySchema = new Schema({
+  name: {
+    type: String,
+    required: true,
+  },
+  user: {
+    type: Schema.Types.ObjectId,
+    ref: "User",
+  },
+  energyImpact: {
+    type: Number,
+    required: true,
+  },
+  category: {
+    type: String,
+    required: true,
+  },
+});
+
+export const Activity = model("activity", activitySchema);

backend/models/DailyPlan.js

@@ -0,0 +1,32 @@
+import { Schema, model } from "mongoose";
+
+const dailyPlanSchema = new Schema({
+  // One unique id-person that points to the User model. The owner of the dailyplan.
+  user: {
+    type: Schema.Types.ObjectId,
+    ref: "User",
+    required: true,
+  },
+  date: {
+    type: Date,
+    default: () => new Date(),
+  },
+  startingEnergy: {
+    type: Number,
+  },
+
+  activities: [{
+    type: Schema.Types.ObjectId,
+    ref: "activity",
+  }],
+  currentEnergy: {
+    type: Number,
+  },
+  // The users own note about the day (in History.jsx)
+  notes: {
+    type: String,
+    default: "",
+  }
+});
+
+export const dailyPlan = model("dailyPlan", dailyPlanSchema);

backend/models/User.js

@@ -0,0 +1,25 @@
+import { Schema, model } from "mongoose";
+import crypto from "crypto";
+
+// These are required (name, email, password). accessToken is generated with crypto. 
+const userSchema = new Schema({
+  name: {
+    type: String,
+    required: true,
+  },
+  email: {
+    type: String,
+    required: true,
+    unique: true,
+  },
+  password: {
+    type: String,
+    required: true,
+  },
+  accessToken: {
+    type: String,
+    default: () => crypto.randomBytes(128).toString("hex")
+  }
+});
+
+export const User = model("User", userSchema);

backend/package.json

@@ -12,9 +12,12 @@
     "@babel/core": "^7.17.9",
     "@babel/node": "^7.16.8",
     "@babel/preset-env": "^7.16.11",
+    "bcrypt": "^6.0.0",
     "cors": "^2.8.5",
+    "dotenv": "^17.2.4",
     "express": "^4.17.3",
+    "express-list-endpoints": "^7.1.1",
     "mongoose": "^8.4.0",
     "nodemon": "^3.0.1"
   }
-}
+}

backend/routes/activitiesRoutes.js

@@ -0,0 +1,64 @@
+import express from "express";
+import { Activity } from "../models/Activity.js";
+import { authenticateUser } from "../middleware/authMiddleware.js";
+
+export const router = express.Router();
+
+// GET /activities. Gets default activities + the current user's own activities.
+router.get("/activities", authenticateUser, async (req, res) => {
+  try {
+    const activities = await Activity.find({
+      $or: [{ user: { $exists: false } }, { user: null }, { user: req.user._id }]
+    });
+    res.json(activities);
+  } catch (error) {
+    res.status(500).json({ error: "Could not fetch activities" });
+  }
+});
+
+// POST /activities. Adding a new activity to the database. needs a auth. 
+router.post("/activities", authenticateUser, async (req, res) => {
+  try {
+    const { name, energyImpact, category } = req.body;
+    if (!name || !energyImpact || !category) {
+      return res.status(400).json({ error: "Name, energyImpact and category are required" });
+    }
+
+    const activity = new Activity({ name, energyImpact, category, user: req.user._id });
+    await activity.save();
+    res.status(201).json(activity);
+  } catch (error) {
+    res.status(500).json({ error: "Could not create activity" });
+  }
+});
+
+// PATCH /activities. Updates an activity. 
+router.patch("/activities/:id", authenticateUser, async (req, res) => {
+  try {
+    const { id } = req.params;
+    const updates = req.body;
+    const activity = await Activity.findByIdAndUpdate(id, updates, { new: true });
+
+    if (!activity) {
+      return res.status(404).json({ error: "Activity not found" });
+    }
+    res.json(activity);
+  } catch (error) {
+    res.status(400).json({ error: "Could not update activity" });
+  }
+});
+
+// DELETE /activities. Deletes an activity
+router.delete("/activities/:id", authenticateUser, async (req, res) => {
+  try {
+    const { id } = req.params;
+    const deletedActivity = await Activity.findByIdAndDelete(id);
+
+    if (!deletedActivity) {
+      return res.status(404).json({ error: `Activity with id ${id} does not exist` });
+    }
+    res.json(deletedActivity);
+  } catch (error) {
+    res.status(500).json({ error: "Could not delete activity" });
+  }
+});