SubscriBee - by Sofie, Sofia & Oskar #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

ssofiejohansson wants to merge 458 commits into Technigo:main from ssofiejohansson:main

.github/workflows/update-reminders-freetrial.yml

-Original file line number
+Diff line change
@@ -0,0 +1,24 @@
+    name: Update Reminder Dates - Free Trial
+    on:
+      schedule:
+        - cron: "0 0 * * *" # every midnight UTC
+      workflow_dispatch: # allows you to run it manually from GitHub UI
+    jobs:
+      update:
+        runs-on: ubuntu-latest
+        steps:
+          - name: Call backend to update reminder dates
+            run: |
+              curl -v --http1.1 -X PATCH "https://project-final-xhjy.onrender.com/date/update-reminders" \
+                -H "Authorization: ${{ secrets.API_SECRET }}" \
+                -H "Content-Type: application/json"
+          - name: Call backend to decrement freeTrial
+            run: |
+              curl -v --http1.1 -X PATCH "https://project-final-xhjy.onrender.com/freetrial/update-freetrial" \
+                -H "Authorization: ${{ secrets.API_SECRET }}" \
+                -H "Content-Type: application/json"

.vscode/tasks.json

-Original file line number
+Diff line change
@@ -0,0 +1,20 @@
+    {
+      "version": "2.0.0",
+      "tasks": [
+        {
+          "label": "Start Backend Server",
+          "type": "shell",
+          "command": "npm",
+          "args": [
+            "run",
+            "dev"
+          ],
+          "group": "build",
+          "isBackground": true,
+          "options": {
+            "cwd": "${workspaceFolder}/backend"
+          },
+          "problemMatcher": []
+        }
+      ]
+    }

0 Procfile → Profile

File renamed without changes.

README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,13 +1,90 @@
  
    # Final Project

    # Welcome to SubscriBee  

    ![Beeatrice the bee](https://subscribee-project.netlify.app/subscribee-logo.webp)

    Replace this readme with your own information about your project.

    A project by Oskar Nordin, Sofie Johansson & Sofia Lennbom

    Start by briefly describing the assignment in a sentence or two. Keep it short and to the point.

    ## The problem:

    ## The problem

    People tend to forget which subscriptions they have and what the fee is and keep paying for them despite not using them.  

    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?

    ## Describe how you approached the problem, and what tools and techniques you used to solve it:

    To solve the problem, we created an application where the user can add all their subscriptions and display them on a dashboard.  

    ### The dashboard show:

    - Quantity

    - Monthly and yearly cost

    - Subscription category

    - Status: active or inactive

    - Free trial and trial days, with count down

    - Line graph of costs by month

    - Reminder for the next upcoming 3 days

    - Filtering by category

    - Sort by name, cost, reminder date and status 

    ### Other features

    - The user can choose to get notifications by email on the set reminder date

    - When a subscription gets cancelled or change status to inactive, Beeatrice the bee notifies the user

    - She lets the user know how much the yearly save is and what they can spend the money on instead 

    ## How did you plan?

    - Daily standups for motivation and keep everyone on track.

    - A board with tasks in Notion to get an overview.

    - We decided early to focus on getting all the functionality running before we added any styling.  

    ## What technologies did you use?

    ### Frontend

    - Core: HTML5, JavaScript (ES6+), React

    - Build Tool: Vite

    - Styling: Tailwind CSS, with Material Tailwind for UI components

    - Routing: React Router

    - State Management: Zustand

    - Data Visualization: ApexCharts for graphs and charts

    - Icons: Heroicons  

    ### Backend

    - Core: Node.js, Express.js

    - Database: MongoDB with Mongoose as the ODM

    - Email Service: Nodemailer for sending emails

    - Task Scheduling: node-cron for recurring tasks

    - Authentication: Custom token-based authentication middleware  

    ## Tooling & Deployment

    - Version Control: Git

    - Automation: GitHub Actions (workflow automation via .yml pipelines for tasks such as database updates)

    - Hosting: Frontend on Netlify, Backend on Render 

    ## If you had more time, what would be next?

    - An admin page to get an overview of and handle scheduled emails, users etc

    - Expand the focus on contribution to choose from different charity organisations  

    ## View it live

    https://subscribee-project.netlify.app/

    ## Dependencies

    ### Frontend

    - npm i heroicons

    - npm i @material-tailwind/react

    - npm i apexcharts

    - npm i react-apexcharts

    - npm i express-list-routes

    - npm i framer-motion

    - npm i lodash

    - npm i react-router-hash-link

    - npm i zustand

    - npm install -D tailwindcss@3

    - npx tailwindcss init

    ### Backend

    - npm i nodemailer

    - npm i nodemon

    - npm i nodecron

    - npm i mongoose

    - npm i dotenv

    - npm i bcrypt

    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.
      
    ## How to install & run

    - npm i

    - npm run dev

backend/README.md

This file was deleted.

backend/authMiddleware.js

-Original file line number
+Diff line change
@@ -0,0 +1,23 @@
+    import { User } from "./models/User.js"
+    export const authenticateUser = async (req, res, next) => {
+      try {
+        const user = await User.findOne({
+          accessToken: req.header("Authorization"),
+        })
+        if (user) {
+          req.user = user
+          next();
+        } else {
+          res.status(401).json({
+            message: "Authentication missing or invalid",
+            loggedOut: true,
+          })
+        }
+      } catch (error) {
+        res.status(500).json({
+          message: "Internal server error", error: err.message
+        })
+      }
+    }

backend/models/ScheduledEmail.js

-Original file line number
+Diff line change
@@ -0,0 +1,55 @@
+    import mongoose from 'mongoose';
+    const scheduledEmailSchema = new mongoose.Schema(
+      {
+        to: {
+          type: String,
+          required: true,
+        },
+        subject: {
+          type: String,
+          required: true,
+        },
+        text: {
+          type: String,
+          required: true,
+        },
+        scheduledDateTime: {
+          type: Date,
+          required: true,
+        },
+        isRecurring: {
+          type: Boolean,
+          default: false,
+        },
+        status: {
+          type: String,
+          enum: ['scheduled', 'sent', 'failed'],
+          default: 'scheduled',
+        },
+        lastSent: {
+          type: Date,
+        },
+        nextRun: {
+          type: Date,
+        },
+        attempts: {
+          type: Number,
+          default: 0,
+        },
+        errorMessage: {
+          type: String,
+        },
+      },
+      {
+        timestamps: true,
+      }
+    );
+    // Index for efficient querying of due emails
+    scheduledEmailSchema.index({ nextRun: 1, status: 1 });
+    export const ScheduledEmail = mongoose.model(
+      'ScheduledEmail',
+      scheduledEmailSchema
+    );

backend/models/Subscription.js

-Original file line number
+Diff line change
@@ -0,0 +1,55 @@
+    import mongoose from 'mongoose';
+    const subscriptionSchema = new mongoose.Schema({
+      name: {
+        type: String,
+        required: true,
+        minlength: 3,
+        maxlength: 100,
+      },
+      cost: {
+        type: Number,
+        required: true,
+        min: 0,
+      },
+      freeTrial: {
+        type: Boolean,
+        default: false,
+      },
+      //days of free trial
+      trialDays: {
+        type: Number,
+        minlength: 0,
+      },
+      //Next remider email
+      reminderDate: {
+        type: Date,
+        required: true,
+      },
+      status: {
+        type: String,
+        enum: ['active', 'inactive'],
+        default: 'active',
+        required: true,
+      },
+      category: {
+        type: String,
+        enum: ['Entertainment', 'Food', 'Health', 'Learning', 'Other'],
+        required: true,
+      },
+      createdAt: {
+        type: Date,
+        default: Date.now,
+      },
+      user: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'User',
+        required: true,
+      },
+      sendEmail: {
+        type: Boolean,
+        default: true,
+      },
+    });
+    export const Subscription = mongoose.model('Subscription', subscriptionSchema);

backend/models/User.js

-Original file line number
+Diff line change
@@ -0,0 +1,30 @@
+    import crypto from "crypto"
+    import mongoose from "mongoose"
+    const userSchema = new mongoose.Schema({
+      name: {
+        type: String,
+        required: true,
+        minlength: 3,
+        maxlength: 100
+      },
+      email: {
+        type: String,
+        required: true,
+        unique: true,
+        minlength: 5,
+        maxlength: 100,
+      },
+      password: {
+        type: String,
+        required: true,
+        minlength: 3,
+        maxlength: 100,
+      },
+      accessToken: {
+        type: String,
+        default: () => crypto.randomBytes(128).toString("hex")
+      }
+    })
+    export const User = mongoose.model("User", userSchema)

backend/package.json

-Original file line number
+Diff line change
@@ -1,6 +1,7 @@
     {
       "name": "project-final-backend",
       "version": "1.0.0",
+      "type": "module",
       "description": "Server part of final project",
       "scripts": {
         "start": "babel-node server.js",
@@ Expand All / @@ -12,9 +13,15 @@ @@
         "@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.1",
         "express": "^4.17.3",
-        "mongoose": "^8.4.0",
+        "express-list-endpoints": "^7.1.1",
+        "lodash": "^4.17.21",
+        "mongoose": "^8.17.0",
+        "node-cron": "^3.0.3",
+        "nodemailer": "^7.0.5",
         "nodemon": "^3.0.1"
       }
-    }
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SubscriBee - by Sofie, Sofia & Oskar #117

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!

Uh oh!

SubscriBee - by Sofie, Sofia & Oskar #117

Are you sure you want to change the base?

Uh oh!

SubscriBee - by Sofie, Sofia & Oskar #117

Uh oh!

Diff view

Diff view

Uh oh!

There are no files selected for viewing

Uh oh!

Uh oh!