eGo

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.tabSize": 2
+}

README.md

@@ -1,13 +1,61 @@
-# Final Project
+<h1 align="center">Welcome to eGo 👋</h1>
+<p>
+  <a href="https://project-final-1-4w43.onrender.com" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+</p>
 
-Replace this readme with your own information about your project.
+> eGo is a mobile app that rewards eco-friendly travel choices. Integrated with the Google Routing API, it suggests low-emission routes for walking, cycling, public transport, and carpooling. Users earn &#34;Green Points&#34; for sustainable travel.
+> Developed with React, MongoDB, and styled-components, eGo tracks carbon footprint reduction and helps users set sustainability goals.
 
-Start by briefly describing the assignment in a sentence or two. Keep it short and to the point.
+### ✨ [Demo](https://ego-app.netlify.app/)
 
-## The problem
+## Tech stack
+<ul>
+  <li>Styled-components</li>
+  <li>Material UI </li>
+  <li>Cloudinary</li>
+  <li>Chart.js</li>
+  <li>React-google-autocomplete</li>
+  <li>React-joyride</li>
+</ul>
 
-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?
+## Development process
 
-## View it live
+## 1 Step
+We designed the interface in Figma, established the primary database models, and set up the main server routes.
+## 2 Step
+We set up all the backend endpoints for user registration and login, and on the frontend, we implemented the forms and main component.
+## 3 Step
+We implemented a model for travels and stored points in the backend. On the frontend, we integrated all necessary travel forms, graphs, and components.
+## 4 Step
+We integrated the admin functionality and its dashboard and worked on the final documentation.To make the whole app more user-friendly we integrated a walkthrough.
 
-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.
+## Extra features
+If we had more time we would start integrate the following features:
+- Rewards for points
+- Weather data 
+- Add a function for display the password to the user when they log in 
+- AI coach integration.
+- Add function for the user to upload their profile image to Cloudinary.
+- Integrate carbon footprints API.
+
+## Install
+
+```sh
+npm install
+```
+
+## Usage
+
+```sh
+npm run dev
+```
+
+## Author
+
+👤 ** [Yifan](https://github.com/Yifan-858) -  [Kathinka](https://github.com/kathinka) -  [Eliane ](https://github.com/El1an3 )  - [Vittoria](https://github.com/vittoriamatteoli)** 
+
+## Show your support
+
+Give a ⭐️ if this project helped you!

backend/.gitignore

@@ -0,0 +1,15 @@
+node_modules
+.DS_Store
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+build
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+package-lock.json

backend/middleware/middleware.js

@@ -0,0 +1,73 @@
+import User from "../models/user-model.js"
+import dotenv from "dotenv"
+import jwt from "jsonwebtoken"
+
+dotenv.config()
+const SECRET = process.env.SECRET || "toast is the best secret"
+
+const authenticateUser = async (req, res, next) => {
+  try {
+    const authHeader = req.header("Authorization")
+    if (!authHeader) {
+      return res.status(401).json({
+        loggedOut: true,
+        message: "Authorization header is missing",
+      })
+    }
+
+    const parts = authHeader.split(" ")
+    if (parts.length !== 2 || parts[0] !== "Bearer") {
+      return res.status(401).json({
+        loggedOut: true,
+        message: "Invalid authorization format. Expected 'Bearer <token>'",
+      })
+    }
+
+    const accessToken = parts[1]
+    req.accessToken = accessToken // add the token to the request object in case we need it for later use in other middlewares..
+
+    const decoded = jwt.verify(accessToken, SECRET)
+    if (!decoded) {
+      return res.status(403).json({
+        message: "Invalid access token",
+      })
+    }
+    const user = await User.findOne({ _id: decoded.id , role:decoded.role});
+    if (!user) {
+      return res.status(404).json({
+        message: "User not found",
+      })
+    }
+    req.user = user
+    next()
+  } catch (error) {
+    res.status(403).json({ message: "Access forbidden", error: error.message })
+  }
+}
+
+// add authorization to the routes that need it, if we want to make an GUI for the admins who can see all users and their data and preform operations on the data - or if we want some kind of superusers (paid access for instance - but then we need to add "roles" to the user model)
+
+const authorizeUser = (role) => {
+  return (req, res, next) => {
+    if (!role.includes(req.user.role)) {
+      return res.status(403).json({ message: "Access forbidden" });
+    }
+    next()
+  }
+}
+
+// log out the user (and lets remmeberdelete the session token)
+const signOut = async (req, res) => {
+  try {
+    const user = req.user
+    // option to add the used token to a blacklist if we want to set that up
+    //option to add a refresh token if we want the service to "remember" the user and keep the user logged in for a longer period of time.
+    //user.refreshToken = null;
+    //await user.save();
+    res.json({ message: "User logged out successfully" })
+  } catch (error) {
+    res.status(500).json({ message: "Error logging out", error: error.message })
+  }
+}
+
+export { authenticateUser, authorizeUser, signOut }

backend/models/points-model.js

@@ -0,0 +1,26 @@
+import mongoose from 'mongoose';
+
+const pointsSchema = new mongoose.Schema({
+  points: {
+    type: Number,
+    required: [true, "Points is required"],
+    min: [0, "Points cannot be negative"],
+  },
+  user: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: 'User',
+    requred: [true, "User is required"],
+  },
+  travel: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: 'Travel',
+    required: [true, "Travel is required"],
+  },
+  date:{
+    type: Date,
+    required: [true, "Date is required"],
+  default: Date.now,
+  },
+});
+
+export default mongoose.model('Points', pointsSchema);

backend/models/travel-model.js

@@ -0,0 +1,52 @@
+import mongoose from "mongoose";
+import { updatePoints } from "../utils/updatePoints";
+
+const travelSchema = new mongoose.Schema({
+  distance: {
+    type: Number,
+    required: [true, "Distance is required"],
+    min: [0, "Distance cannot be negative"],
+  },
+  mode: {
+    type: String,
+    enum: ["DRIVE", "BICYCLE", "WALK", "TRANSIT"],
+    required: [true, "Way of travel is required"],
+  },
+  date: {
+    type: Date,
+    default: () => Date.now(),
+  },
+  origin: {
+    type: String,
+    required: [true, "Start location is required"],
+  },
+  destination: {
+    type: String,
+    required: [true, "End location is required"],
+  },
+  user: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: "User",
+    required: [true, "User is required"],
+  },
+  travelPoints: {
+    type: Number,
+    required: [true, "Travel points are required"],
+  },
+});
+
+// Update user's points after saving a travel
+travelSchema.post("save", function (doc, next) {
+  const userId = doc.user;
+  const travelId = doc._id;
+  const travelPoints = doc.travelPoints;
+  console.log("calculated points by travelschema:", travelPoints);
+  console.log("userId by travelschema:", userId);
+  console.log("travelId by travelschema:", travelId);
+
+  updatePoints(userId, travelId, travelPoints)
+    .then(() => next())
+    .catch((err) => next(err));
+});
+
+export default mongoose.model("Travel", travelSchema);

backend/models/user-model.js

@@ -0,0 +1,86 @@
+import mongoose from "mongoose";
+import bcryptjs from "bcryptjs";
+import { getRandomAvatarUrl } from "../utils/avatarUtils.js";
+
+const SALT_ROUNDS = 12; // make this configurable so we can adjust the security level if needed
+
+const userSchema = new mongoose.Schema({
+  username: {
+    type: String,
+    required: [true, "Username is required"],
+    minlength: [3, "Username must be at least 3 characters long"],
+    maxlength: [30, "Username must be at most 30 characters long"],
+    unique: true,
+  },
+  email: {
+    type: String,
+    required: [true, "Email is required"],
+    unique: true,
+    match: [/\S+@\S+\.\S+/, "Email is invalid"],
+  },
+  password: {
+    type: String,
+    required: [true, "Password is required"],
+    minlength: [6, "Password must be at least 6 characters long"],
+  },
+  role: {
+    type: String,
+    default: "user",
+  },
+  // optional field for a refresh token if we want to keep the user logged in for a longer period of time
+  //refreshToken: {
+  //  type: String,
+  //  default: null,
+  // },
+
+  points: {
+    type: Number,
+    default: 0,
+  },
+  energyLevel: {
+    type: Number,
+    default: 5,
+  },
+  avatarUrl: {
+    type: String,
+    default: function () {
+      return getRandomAvatarUrl();
+    },
+  },
+});
+//update the users travelpoints after saving a travel
+userSchema.methods.incrementPoints = function (points) {
+  return this.model("User")
+    .updateOne({ _id: this._id }, { $inc: { points: points } })
+    .then(() => {
+      console.log(
+        `Points incremented by ${points}. New points: ${this.points + points}`
+      );
+    })
+    .catch((error) => {
+      console.error(`Error incrementing points: ${error}`);
+    });
+};
+
+//this uses matchPassword method to compare the entered password with the hashed password in the database
+userSchema.methods.matchPassword = async function (enteredPassword) {
+  return await bcryptjs.compare(enteredPassword, this.password);
+};
+//This adds a pre-save (pre) hook to hash the password *before* saving it to the database so we don't store the password in plain text
+userSchema.pre("save", async function (next) {
+  // we only hash the password if it has been modified (or is new)
+  if (!this.isModified("password")) {
+    return next();
+  }
+
+  this.password = await bcryptjs.hash(this.password, SALT_ROUNDS);
+
+  // set a random avatar URL for new users
+  if (this.isNew) {
+    this.avatarUrl = this.avatarUrl || getRandomAvatarUrl();
+  }
+
+  next();
+});
+
+export default mongoose.model("User", userSchema);

backend/package.json

@@ -9,12 +9,18 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@babel/core": "^7.17.9",
-    "@babel/node": "^7.16.8",
-    "@babel/preset-env": "^7.16.11",
+    "@babel/core": "^7.24.6",
+    "@babel/node": "^7.24.6",
+    "@babel/preset-env": "^7.24.6",
+    "bcryptjs": "^2.4.3",
     "cors": "^2.8.5",
-    "express": "^4.17.3",
+    "dotenv": "^16.4.5",
+    "express": "^4.19.2",
+    "express-list-endpoints": "^7.1.0",
+    "jsonwebtoken": "^9.0.2",
+    "jwt-decode": "^4.0.0",
     "mongoose": "^8.4.0",
-    "nodemon": "^3.0.1"
+    "nodemon": "^3.1.2",
+    "react-google-autocomplete": "^2.7.3"
   }
-}
+}