Merge Development Files into Main

.gitignore

@@ -1,9 +1,23 @@
 # local env files
+.DS_Store
+.env
 .env.local
 .env.development.local
 .env.test.local
 .env.production.local
 
-/node_modules
-
+# other files
 *.bkp
+*.DS_Store*
+package-lock.json
+.pnp.js
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# directories
+build
+coverage
+node_modules
+.vscode
+.pnp

Deliverables/Deliverable_3.md

@@ -0,0 +1,44 @@
+# System Description
+*Provide a brief textual description of your system. The first paragraph of the description must contain the problem statement, the product position statement, and the value proposition of your system (you can refine/update what you presented in D.2). The following paragraphs should describe the key requirements of the system. This description should be consistent with D.2 stakeholders, requirements, use cases, and user stories. Again, refinements/updates are welcome since your understanding of the system is constantly evolving.*
+
+*Use Bold every time you use a noun that is a class in your model. Use Italic every time you use a noun that is an attribute in your model. Use Bold and Italic every time you use a noun or verb that is an association in your model.* 
+
+*Grading criteria (5 points): The description should be clear, concise, and well-written, free of typos and grammar problems. The use of bold, italic, and underline should be coherent with the model presented in Section 2---all classes, attributes, and associations from the model should appear in the text consistently with the model.*
+
+Our project focuses on the problem of difficulty in connecting with peers for study collaboration affects college students across various disciplines, particularly those in larger universities who may feel isolated or unsure about finding study groups. The impact of this problem is diminished academic performance, increased stress, and lost opportunities for social interaction and skill development, which can lead to lower retention rates and a lack of community among students. The product is for college students who struggle to find and connect with study groups for collaborative learning. The name of the product is StudySphere which is a web platform that simplifies the process of discovering, joining and scheduling study groups to enhance academic success and build community. Unlike traditional social media platforms or general messaging apps. Our product focuses specifically on connecting students based on their courses and study needs, fostering a supportive academic environment. StudySphere empowers students to collaborate by simplifying the process of finding and connecting with study groups, enhancing academic success aligning with our slogan "Study Smarter Together”.
+
+StudySphere allows students to create, manage, and delete their own **student accounts** as needed. The creation of the **student account** deals with attributes such as *email, password, username, Firstname, Lastname, and college* all of which are required prior to account creation. *username* cannot be changed post-registration. Users also have the ability to delete their **student accounts** if they feel the need to do so. The management part of the system relates to the user settings, a subset of account management covered in the following paragraph.
+
+A key requirement in Study Sphere is managing **user settings**, this requirement allows students to manage their **student account** information. Through **user settings** a student can manage information such as *First name, Last name, email, university, profile picture, display name, and password* This feature is critical for accommodating different user needs and preferences, allowing students to customize their interaction with **groups, message threads,** and other platform features. Personalizing these settings ensures a flexible user experience. 
+
+StudySphere offers **group chats** that are moderately customizable in order to enhance the overall user experience and allow for efficient communication between students ( the main purpose of the product ). Each **group chat** allows the **owner** or **administrators** to modify **attributes** such as *group profile picture, group description, group title, members, member count limit, calendar updates, the deletion of the group, the creation of the group, and background color*. These **group chats** provide real time communication between **student accounts** and **groups**, enabling **users** to communicate effectively, plan meetings or study sessions, and most importantly making friends within their community.
+
+Another essential feature requirement involves managing **group settings**. This functionality allows students to customize key aspects of any **group** they create or join, including setting a *group name*, providing a *group description*, and determining the *member limit*. Additionally, users can view the *Group ID* and the *Member IDs* of group participants, ensuring each **group** is tailored to meet specific study needs. This capability fosters a safe, organized, and collaborative space, where members can engage effectively in their academic pursuits.
+
+**[OTHER PARAGRAPHS HERE]**
+
+For the non-functional requirements, performance is critical to ensure smooth interactions with the platform. The user experience relies on *low latency* and consistent guaranteed performance,as it directly impacts usability and user satisfaction. The system should maintain a response time of less than 5 seconds for chat and other high-priority interactions. Performance is especially emphasized in user stories like "Jack's" need to communicate with group members and schedule times efficiently.
+
+Platform security is at the forefront of our design in order to keep user data secure. The system must disallow unauthenticated users from interacting with the system. Additionally, authentication must be handled in a secure manner with the *password* being properly encoded/hashed/encrypted both during transmission and when it is being stored.
+
+Scalability is important to the future of our project. In order to serve a potentially growing user base, the system must be structured to minimize the maintenance overhead that comes with mismatched scaling expectations. Failure to do so may result in unanticipated system errors and/or downtime, which would decrease the reliability of the system.
+
+Compatibility across devices is essential to ensure that the platform is accessible by students using different systems, whether on mobile,or desktops. Multi-device functionality allows a seamless user experience regardless of device and browser, allowing for better access. Compatibility and better accessibility is directly in line with our goal of making study groups more widespread and easier to find.
+
+# Model
+*Provide the conceptual model of your system as a UML class diagram. Represent proper cardinalities (multiplicities) for all associations. Also include the association names.* 
+
+*Some points to consider:*
+
+- *Use UML adequately. Do not use graphical elements that are not part of the language. Represent compositions and aggregations when relevant.*
+- *This model is not an ER diagram (entity-relationship model), which is focused on relational database systems. However, both diagrams have similarities.* 
+- *Do not overcomplicate how you represent the elements of your model (e.g., using inheritance or an association when they are not necessary). Pay attention to simplicity, maintainability, unnecessary repetition, cohesion, and coupling.*
+- *Do not represent actions that don’t need to be registered in the system.* 
+- *Do not represent technical elements, such as user interface or programming language libraries in the model. At this point, we are modeling the business logic/domain of your system. The model will be refined during the design phase to include technology-specific elements and decisions.* 
+- *Do not represent "System" as a class in your model. Everything that you are modeling is part of the system.*
+- *If you need to justify your decisions, you can write your rationale in this section or use UML comments in the diagram.*
+- *The model must have at least 8 classes. If you need more classes, you can add requirements in the system description that did not appear in D2.*
+
+*Grading criteria: You should correctly use the UML specification. Your model should have the minimum number of classes. Your domain should be adequately modeled. The model should avoid unnecessary complexity, repetition, lack of cohesion, and coupling. The classes should be at an adequate abstraction level.*
+
+**[insert model here]**

node_modules/bson/LICENSE.md → LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2024 Rudra Amin, Alexander Anthis, Jadyn Calhoun, Jack Lealos, Daira Santacruz, Valentino Valero
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

backend/config/db.js

@@ -0,0 +1,23 @@
+const mongoose = require("mongoose");
+const dotenv = require("dotenv").config();
+
+const connectDB = async () => {
+    const MONGO_URI = process.env.MONGO_URI
+    const MONGO_USERNAME = process.env.MONGO_USERNAME
+    const MONGO_PASSWORD = process.env.MONGO_PASSWORD
+    const MONGO_DATABASE = process.env.MONGO_DATABASE
+    const MONGO_CONN_DETAILS = `mongodb+srv://${MONGO_USERNAME}:${MONGO_PASSWORD}@${MONGO_URI}/${process.env.MONGO_DATABASE}`
+
+    console.log(`\x1b[32mConnecting to Mongo as '${MONGO_USERNAME}'\x1b[0m`)
+    console.log(`\x1b[32mUsing database '${MONGO_DATABASE}'\x1b[0m`)
+
+    try {
+        const conn = await mongoose.connect(MONGO_CONN_DETAILS);
+        console.log(`MongoDB Connected: ${conn.connection.host}`);
+    } catch (error) {
+        console.log(error);
+        process.exit(1);
+    }
+}
+
+module.exports = connectDB;

backend/config/generateToken.js

@@ -0,0 +1,16 @@
+const jwt = require("jsonwebtoken")
+
+const generateTokenSetCookie = (id, res) => {
+    const token = jwt.sign({id}, process.env.JWT_SECRET, {
+        expiresIn: "15d"
+    });
+
+	res.cookie("jwt", token, {
+		maxAge: 15 * 24 * 60 * 60 * 1000, // MS
+		httpOnly: true, // prevent XSS attacks cross-site scripting attacks
+		sameSite: "strict", // CSRF attacks cross-site request forgery attacks
+		secure: process.env.NODE_ENV !== "development",
+	});
+}
+
+module.exports = generateTokenSetCookie;