├── frontend
    ├── .env.example
    ├── src
    │   ├── context
    │   │   ├── index.js
    │   │   └── AuthProvider.jsx
    │   ├── api
    │   │   ├── index.js
    │   │   ├── axios.js
    │   │   └── AccountApi.js
    │   ├── models
    │   │   ├── index.js
    │   │   ├── gender.js
    │   │   └── filter.js
    │   ├── assets
    │   │   ├── map.jpg
    │   │   ├── moving_out.jpg
    │   │   ├── roommates.jpg
    │   │   └── dallas_skyline.jpg
    │   ├── components
    │   │   ├── domain
    │   │   │   ├── Account
    │   │   │   │   ├── index.js
    │   │   │   │   ├── Login.jsx
    │   │   │   │   └── Registration.jsx
    │   │   │   ├── Dashboard
    │   │   │   │   ├── index.js
    │   │   │   │   ├── ProfileExplorer.jsx
    │   │   │   │   ├── ResultList.jsx
    │   │   │   │   └── ProfileSearch.jsx
    │   │   │   ├── index.js
    │   │   │   ├── Profile
    │   │   │   │   ├── index.js
    │   │   │   │   ├── AvatarUpload.jsx
    │   │   │   │   ├── RoommateList.jsx
    │   │   │   │   ├── RequestList.jsx
    │   │   │   │   ├── ProfileDetails.jsx
    │   │   │   │   └── ProfileEditor.jsx
    │   │   │   └── Routing
    │   │   │   │   ├── index.js
    │   │   │   │   ├── RequireAuth.jsx
    │   │   │   │   ├── Missing.jsx
    │   │   │   │   ├── PersistentLogin.jsx
    │   │   │   │   ├── Router.jsx
    │   │   │   │   ├── NavBar.jsx
    │   │   │   │   └── LandingPage.jsx
    │   │   ├── common
    │   │   │   ├── index.js
    │   │   │   ├── Footer.jsx
    │   │   │   ├── TextAreaField.jsx
    │   │   │   ├── CheckBoxField.jsx
    │   │   │   ├── SearchField.jsx
    │   │   │   ├── TextField.jsx
    │   │   │   ├── PlainNavBar.jsx
    │   │   │   ├── SelectField.jsx
    │   │   │   ├── CheckBoxDropdown.jsx
    │   │   │   └── CredentialsField.jsx
    │   │   └── App.jsx
    │   ├── hooks
    │   │   ├── index.js
    │   │   ├── useAuth.jsx
    │   │   ├── useLogout.jsx
    │   │   ├── useRefreshToken.jsx
    │   │   └── useAxiosPrivate.jsx
    │   ├── index.js
    │   ├── tests
    │   │   └── App.test.js
    │   └── styles
    │   │   └── styles.css
    ├── public
    │   ├── favicon.ico
    │   ├── logo192.png
    │   ├── images
    │   │   ├── default.jpg
    │   │   └── branding.png
    │   ├── manifest.json
    │   └── index.html
    ├── .gitignore
    └── package.json
├── backend
    ├── .dockerignore
    ├── config
    │   ├── allowedOrigins.js
    │   ├── knex.js
    │   └── corsOptions.js
    ├── Dockerfile
    ├── middleware
    │   ├── errorHandler.js
    │   ├── credentials.js
    │   ├── createModels.js
    │   ├── verifyJWT.js
    │   └── logEvents.js
    ├── .gitignore
    ├── controllers
    │   ├── logoutController.js
    │   ├── authController.js
    │   └── refreshTokenController.js
    ├── knexfile.js
    ├── .env.example
    ├── migrations
    │   ├── 20221120224806_add_requests_table.js
    │   ├── 20221101182132_add_users_table.js
    │   ├── 20221110205801_add_preferences_table.js
    │   └── 20221124033752_add_house_table.js
    ├── routes
    │   ├── roommate.js
    │   ├── register.js
    │   ├── avatar.js
    │   ├── session.js
    │   ├── request.js
    │   └── user.js
    ├── package.json
    ├── index.js
    ├── models
    │   ├── request.js
    │   ├── avatar.js
    │   ├── user.js
    │   └── roommate.js
    └── tests
    │   └── api.test.js
├── .github
    └── workflows
    │   ├── build.yml
    │   └── deploy.yml
├── README.md
└── LICENSE


/frontend/.env.example:
--------------------------------------------------------------------------------
1 | REACT_APP_API_URL=


--------------------------------------------------------------------------------
/backend/.dockerignore:
--------------------------------------------------------------------------------
1 | /usr/src/app/node-modules/


--------------------------------------------------------------------------------
/frontend/src/context/index.js:
--------------------------------------------------------------------------------
1 | export * from "./AuthProvider";
2 | 


--------------------------------------------------------------------------------
/frontend/src/api/index.js:
--------------------------------------------------------------------------------
1 | export * from "./axios";
2 | export * from "./AccountApi";
3 | 


--------------------------------------------------------------------------------
/frontend/src/models/index.js:
--------------------------------------------------------------------------------
1 | export * from "./gender";
2 | export * from "./filter";
3 | 


--------------------------------------------------------------------------------
/frontend/public/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kirkwat/mate-match/HEAD/frontend/public/favicon.ico


--------------------------------------------------------------------------------
/frontend/public/logo192.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kirkwat/mate-match/HEAD/frontend/public/logo192.png


--------------------------------------------------------------------------------
/frontend/src/assets/map.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kirkwat/mate-match/HEAD/frontend/src/assets/map.jpg


--------------------------------------------------------------------------------
/frontend/src/components/domain/Account/index.js:
--------------------------------------------------------------------------------
1 | export * from "./Registration";
2 | export * from "./Login";
3 | 


--------------------------------------------------------------------------------
/frontend/public/images/default.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kirkwat/mate-match/HEAD/frontend/public/images/default.jpg


--------------------------------------------------------------------------------
/frontend/src/assets/moving_out.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kirkwat/mate-match/HEAD/frontend/src/assets/moving_out.jpg


--------------------------------------------------------------------------------
/frontend/src/assets/roommates.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kirkwat/mate-match/HEAD/frontend/src/assets/roommates.jpg


--------------------------------------------------------------------------------
/frontend/public/images/branding.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kirkwat/mate-match/HEAD/frontend/public/images/branding.png


--------------------------------------------------------------------------------
/frontend/src/assets/dallas_skyline.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kirkwat/mate-match/HEAD/frontend/src/assets/dallas_skyline.jpg


--------------------------------------------------------------------------------
/frontend/src/models/gender.js:
--------------------------------------------------------------------------------
1 | export class Gender {
2 |   constructor(id, display) {
3 |     this.id = id;
4 |     this.display = display;
5 |   }
6 | }
7 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Dashboard/index.js:
--------------------------------------------------------------------------------
1 | export * from "./ProfileExplorer";
2 | export * from "./ProfileSearch";
3 | export * from "./ResultList";
4 | 


--------------------------------------------------------------------------------
/backend/config/allowedOrigins.js:
--------------------------------------------------------------------------------
1 | require("dotenv").config();
2 | 
3 | const allowedOrigins = [process.env.CLIENT_URL];
4 | 
5 | module.exports = allowedOrigins;
6 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/index.js:
--------------------------------------------------------------------------------
1 | export * from "./Account";
2 | export * from "./Profile";
3 | export * from "./Dashboard";
4 | export * from "./Routing";
5 | 


--------------------------------------------------------------------------------
/frontend/src/hooks/index.js:
--------------------------------------------------------------------------------
1 | export * from "./useAuth";
2 | export * from "./useLogout";
3 | export * from "./useAxiosPrivate";
4 | export * from "./useRefreshToken";
5 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Profile/index.js:
--------------------------------------------------------------------------------
1 | export * from "./ProfileDetails";
2 | export * from "./ProfileEditor";
3 | export * from "./RoommateList";
4 | export * from "./RequestList";
5 | 


--------------------------------------------------------------------------------
/frontend/src/models/filter.js:
--------------------------------------------------------------------------------
1 | export class Filter {
2 |   constructor(id, display, value) {
3 |     this.id = id;
4 |     this.display = display;
5 |     this.value = value;
6 |   }
7 | }
8 | 


--------------------------------------------------------------------------------
/backend/Dockerfile:
--------------------------------------------------------------------------------
 1 | FROM node:18
 2 | 
 3 | WORKDIR /usr/src/app
 4 | 
 5 | COPY package.json .
 6 | 
 7 | RUN npm install
 8 | 
 9 | COPY . .
10 | 
11 | EXPOSE 8000
12 | 
13 | CMD ["npm", "start"]


--------------------------------------------------------------------------------
/backend/config/knex.js:
--------------------------------------------------------------------------------
1 | const env = require("dotenv");
2 | const knexConfig = require("../knexfile");
3 | const knex = require("knex");
4 | 
5 | module.exports = knex(knexConfig.development);
6 | 


--------------------------------------------------------------------------------
/frontend/src/hooks/useAuth.jsx:
--------------------------------------------------------------------------------
1 | import { useContext } from "react";
2 | import { AuthContext } from "../context";
3 | 
4 | export const useAuth = () => {
5 |   return useContext(AuthContext);
6 | };
7 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Routing/index.js:
--------------------------------------------------------------------------------
1 | export * from "./Router";
2 | export * from "./RequireAuth";
3 | export * from "./PersistentLogin";
4 | export * from "./NavBar";
5 | export * from "./LandingPage";
6 | export * from "./Missing";
7 | 


--------------------------------------------------------------------------------
/backend/middleware/errorHandler.js:
--------------------------------------------------------------------------------
 1 | const { logEvents } = require("./logEvents");
 2 | 
 3 | const errorHandler = (err, req, res, next) => {
 4 |   logEvents(`${err.name}: ${err.message}`, "errLog.txt");
 5 |   console.error(err.stack);
 6 |   res.status(500).send(err.message);
 7 | };
 8 | 
 9 | module.exports = errorHandler;
10 | 


--------------------------------------------------------------------------------
/frontend/src/api/axios.js:
--------------------------------------------------------------------------------
 1 | import axios from "axios";
 2 | 
 3 | export default axios.create({
 4 |   baseURL: process.env.REACT_APP_API_URL,
 5 | });
 6 | 
 7 | export const axiosPrivate = axios.create({
 8 |   baseURL: process.env.REACT_APP_API_URL,
 9 |   headers: { "Content-Type": "application/json" },
10 |   withCredentials: true,
11 | });
12 | 


--------------------------------------------------------------------------------
/frontend/src/components/common/index.js:
--------------------------------------------------------------------------------
 1 | export * from "./CheckBoxField";
 2 | export * from "./SelectField";
 3 | export * from "./TextAreaField";
 4 | export * from "./TextField";
 5 | export * from "./SearchField";
 6 | export * from "./CheckBoxDropdown";
 7 | export * from "./CredentialsField";
 8 | export * from "./Footer";
 9 | export * from "./PlainNavBar";
10 | 


--------------------------------------------------------------------------------
/backend/middleware/credentials.js:
--------------------------------------------------------------------------------
 1 | const allowedOrigins = require("../config/allowedOrigins");
 2 | 
 3 | const credentials = (req, res, next) => {
 4 |   const origin = req.headers.origin;
 5 |   if (allowedOrigins.includes(origin)) {
 6 |     res.header("Access-Control-Allow-Credentials", true);
 7 |   }
 8 |   next();
 9 | };
10 | 
11 | module.exports = credentials;
12 | 


--------------------------------------------------------------------------------
/frontend/src/index.js:
--------------------------------------------------------------------------------
 1 | import React from "react";
 2 | import ReactDOM from "react-dom/client";
 3 | import { App } from "./components/App";
 4 | 
 5 | import "bootstrap";
 6 | import "./styles/bootstrap.min.css";
 7 | import "./styles/styles.css";
 8 | 
 9 | const root = ReactDOM.createRoot(document.getElementById("root"));
10 | root.render(
11 |   <React.StrictMode>
12 |     <App />
13 |   </React.StrictMode>
14 | );
15 | 


--------------------------------------------------------------------------------
/frontend/src/context/AuthProvider.jsx:
--------------------------------------------------------------------------------
 1 | import { createContext, useState } from "react";
 2 | 
 3 | export const AuthContext = createContext({});
 4 | 
 5 | export const AuthProvider = ({ children }) => {
 6 |   const [auth, setAuth] = useState({});
 7 | 
 8 |   return (
 9 |     <>
10 |       <AuthContext.Provider value={{ auth, setAuth }}>
11 |         {children}
12 |       </AuthContext.Provider>
13 |     </>
14 |   );
15 | };
16 | 


--------------------------------------------------------------------------------
/frontend/.gitignore:
--------------------------------------------------------------------------------
 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 2 | 
 3 | # dependencies
 4 | /node_modules
 5 | /.pnp
 6 | .pnp.js
 7 | 
 8 | # testing
 9 | /coverage
10 | 
11 | # production
12 | /build
13 | 
14 | # misc
15 | .DS_Store
16 | .env
17 | .env.local
18 | .env.development.local
19 | .env.test.local
20 | .env.production.local
21 | 
22 | npm-debug.log*
23 | yarn-debug.log*
24 | yarn-error.log*


--------------------------------------------------------------------------------
/backend/.gitignore:
--------------------------------------------------------------------------------
 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 2 | /logs
 3 | 
 4 | # dependencies
 5 | /node_modules
 6 | /.pnp
 7 | .pnp.js
 8 | 
 9 | # testing
10 | /coverage
11 | 
12 | # production
13 | /build
14 | 
15 | # misc
16 | .DS_Store
17 | .env
18 | .env.local
19 | .env.development.local
20 | .env.test.local
21 | .env.production.local
22 | 
23 | npm-debug.log*
24 | yarn-debug.log*
25 | yarn-error.log*


--------------------------------------------------------------------------------
/backend/controllers/logoutController.js:
--------------------------------------------------------------------------------
 1 | const User = require("../models/user");
 2 | 
 3 | const handleLogout = async (cookies) => {
 4 |   const refreshToken = cookies.jwt;
 5 | 
 6 |   const users = await User.findUserByRT(refreshToken);
 7 |   if (users.length === 0) return "invalid refreshtoken";
 8 | 
 9 |   await User.createRefreshToken(users[0].email, null);
10 | 
11 |   return "logged out";
12 | };
13 | 
14 | module.exports = { handleLogout };
15 | 


--------------------------------------------------------------------------------
/backend/knexfile.js:
--------------------------------------------------------------------------------
 1 | require("dotenv").config();
 2 | module.exports = {
 3 |   development: {
 4 |     client: "mysql",
 5 |     debug: true,
 6 |     connection: {
 7 |       host: process.env.MYSQL_CLOUD_HOST,
 8 |       port: process.env.MYSQL_PORT,
 9 |       user: process.env.MYSQL_CLOUD_USER,
10 |       password: process.env.MYSQL_CLOUD_PASS,
11 |       insecureAuth: true,
12 |       database: process.env.MYSQL_DB,
13 |     },
14 |   },
15 | };
16 | 


--------------------------------------------------------------------------------
/frontend/src/tests/App.test.js:
--------------------------------------------------------------------------------
 1 | import { render, screen } from "@testing-library/react";
 2 | 
 3 | import { App } from "../components/App";
 4 | 
 5 | describe("App", () => {
 6 |   it("landing page should have create account button", () => {
 7 |     render(<App />);
 8 | 
 9 |     const createAccountButton = screen.getByTestId("create-account-button");
10 | 
11 |     expect(createAccountButton.innerHTML).toBe("Create your Account");
12 |   });
13 | });
14 | 


--------------------------------------------------------------------------------
/frontend/src/hooks/useLogout.jsx:
--------------------------------------------------------------------------------
 1 | import axios from "../api/axios";
 2 | import { useAuth } from "./useAuth";
 3 | 
 4 | export const useLogout = () => {
 5 |   const { setAuth } = useAuth();
 6 | 
 7 |   const logout = async () => {
 8 |     setAuth({});
 9 |     try {
10 |       await axios("/session/logout", {
11 |         withCredentials: true,
12 |       });
13 |     } catch (err) {
14 |       console.error(err);
15 |     }
16 |   };
17 |   return logout;
18 | };
19 | 


--------------------------------------------------------------------------------
/backend/.env.example:
--------------------------------------------------------------------------------
 1 | CLIENT_URL=
 2 |  
 3 | ACCESS_TOKEN_SECRET=
 4 | REFRESH_TOKEN_SECRET=
 5 | 
 6 | MYSQL_DB=
 7 | MYSQL_PORT=
 8 | MYSQL_CLOUD_USER=
 9 | MYSQL_CLOUD_PASS=
10 | MYSQL_CLOUD_HOST=
11 | 
12 | BUCKET_NAME=
13 | BUCKET_REGION=
14 | BUCKET_ACCESS_KEY=
15 | BUCKET_SECRET_ACCESS_KEY=
16 | 
17 | CLOUDFRONT_DISTRIBUTION_ID=
18 | CLOUDFRONT_URL=
19 | CLOUDFRONT_KEY_PAIR_ID=
20 | 
21 | SECRET_REGION=
22 | SECRET_SIGNING_KEY=
23 | 
24 | TEST_USERNAME=
25 | TEST_PASSWORD=


--------------------------------------------------------------------------------
/frontend/src/components/common/Footer.jsx:
--------------------------------------------------------------------------------
 1 | export const Footer = () => {
 2 |   return (
 3 |     <>
 4 |       <footer className="navbar-dark bg-dark mt-4">
 5 |         <div className="container p-4 text-white">
 6 |           <div>Developed and Maintained by Kirk Watson</div>
 7 |           <a href="https://github.com/kirkwat/mate-match">
 8 |             <i className="bi bi-github"></i>
 9 |           </a>
10 |         </div>
11 |       </footer>
12 |     </>
13 |   );
14 | };
15 | 


--------------------------------------------------------------------------------
/backend/middleware/createModels.js:
--------------------------------------------------------------------------------
 1 | const User = require("../models/user");
 2 | const Request = require("../models/request");
 3 | const Roommate = require("../models/roommate");
 4 | const Avatar = require("../models/avatar");
 5 | 
 6 | const createModels = async (req, res, next) => {
 7 |   req.models = {
 8 |     user: User,
 9 |     request: Request,
10 |     roommate: Roommate,
11 |     avatar: Avatar,
12 |   };
13 | 
14 |   next();
15 | };
16 | 
17 | module.exports = createModels;
18 | 


--------------------------------------------------------------------------------
/frontend/src/components/common/TextAreaField.jsx:
--------------------------------------------------------------------------------
 1 | export const TextAreaField = ({ label, value, setValue, rowNum }) => (
 2 |   <>
 3 |     <div className="form-group fw-bold mb-3">
 4 |       <label htmlFor="value">{label}&nbsp;</label>
 5 |       <textarea
 6 |         name="value"
 7 |         id="value"
 8 |         rows={rowNum}
 9 |         className="form-control"
10 |         value={value}
11 |         onChange={(event) => setValue(event.target.value)}
12 |       />
13 |     </div>
14 |   </>
15 | );
16 | 


--------------------------------------------------------------------------------
/backend/config/corsOptions.js:
--------------------------------------------------------------------------------
 1 | const allowedOrigins = require("./allowedOrigins");
 2 | 
 3 | const corsOptions = {
 4 |   origin: (origin, callback) => {
 5 |     if (allowedOrigins.indexOf(origin) !== -1) {
 6 |       callback(null, true);
 7 |     } else {
 8 |       if (origin === undefined) {
 9 |         callback(null, true);
10 |       } else {
11 |         callback(new Error("Not allowed by CORS"));
12 |       }
13 |     }
14 |   },
15 |   optionsSuccessStatus: 200,
16 | };
17 | 
18 | module.exports = corsOptions;
19 | 


--------------------------------------------------------------------------------
/frontend/src/components/App.jsx:
--------------------------------------------------------------------------------
 1 | import { BrowserRouter, Routes, Route } from "react-router-dom";
 2 | import { Router } from "./domain";
 3 | import { Footer } from "./common";
 4 | import { AuthProvider } from "../context/AuthProvider";
 5 | 
 6 | export const App = () => (
 7 |   <>
 8 |     <BrowserRouter>
 9 |       <AuthProvider>
10 |         <Routes>
11 |           <Route path="/*" element={<Router />} />
12 |         </Routes>
13 |       </AuthProvider>
14 |     </BrowserRouter>
15 |     <Footer />
16 |   </>
17 | );
18 | 


--------------------------------------------------------------------------------
/frontend/src/hooks/useRefreshToken.jsx:
--------------------------------------------------------------------------------
 1 | import axios from "../api/axios";
 2 | import { useAuth } from "./useAuth";
 3 | 
 4 | export const useRefreshToken = () => {
 5 |   const { setAuth } = useAuth();
 6 | 
 7 |   const refresh = async () => {
 8 |     const response = await axios.get("/session/refresh", {
 9 |       withCredentials: true,
10 |     });
11 |     setAuth((prev) => {
12 |       return { ...prev, ...response.data };
13 |     });
14 |     return response.data.accessToken;
15 |   };
16 |   return refresh;
17 | };
18 | 


--------------------------------------------------------------------------------
/backend/middleware/verifyJWT.js:
--------------------------------------------------------------------------------
 1 | const jwt = require("jsonwebtoken");
 2 | 
 3 | const verifyJWT = (req, res, next) => {
 4 |   const authHeader = req.headers.authorization;
 5 |   if (!authHeader) {
 6 |     return res.sendStatus(401);
 7 |   }
 8 |   const token = authHeader.split(" ")[1];
 9 |   jwt.verify(token, process.env.ACCESS_TOKEN_SECRET, (err, user) => {
10 |     if (err) {
11 |       return res.sendStatus(403);
12 |     }
13 |     req.user = user;
14 |     next();
15 |   });
16 | };
17 | 
18 | module.exports = verifyJWT;
19 | 


--------------------------------------------------------------------------------
/frontend/public/manifest.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "short_name": "Mate Match",
 3 |   "name": "MateMatch: Find Potential Roommates",
 4 |   "icons": [
 5 |     {
 6 |       "src": "favicon.ico",
 7 |       "sizes": "64x64 32x32 24x24 16x16",
 8 |       "type": "image/x-icon"
 9 |     },
10 |     {
11 |       "src": "logo192.png",
12 |       "type": "image/png",
13 |       "sizes": "192x192"
14 |     }
15 |   ],
16 |   "start_url": ".",
17 |   "display": "standalone",
18 |   "theme_color": "#000000",
19 |   "background_color": "#ffffff"
20 | }
21 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Routing/RequireAuth.jsx:
--------------------------------------------------------------------------------
 1 | import { useLocation, Navigate, Outlet } from "react-router-dom";
 2 | import { useAuth } from "../../../hooks";
 3 | import { NavBar } from "./NavBar";
 4 | 
 5 | export const RequireAuth = () => {
 6 |   const { auth } = useAuth();
 7 |   const location = useLocation();
 8 | 
 9 |   return auth?.accessToken ? (
10 |     <>
11 |       <NavBar />
12 |       <Outlet />
13 |     </>
14 |   ) : (
15 |     <Navigate to="/" state={{ from: location }} replace />
16 |   );
17 | };
18 | 


--------------------------------------------------------------------------------
/frontend/src/components/common/CheckBoxField.jsx:
--------------------------------------------------------------------------------
 1 | export const CheckBoxField = ({ label, checked, setChecked }) => (
 2 |   <>
 3 |     <div className="form-check form-check-inline ps-0 pe-1">
 4 |       <label htmlFor="value">
 5 |         <input
 6 |           type="checkbox"
 7 |           name="value"
 8 |           id="value"
 9 |           checked={checked}
10 |           onChange={() => setChecked(!checked)}
11 |           className="me-2"
12 |         />
13 |         {label}
14 |       </label>
15 |     </div>
16 |   </>
17 | );
18 | 


--------------------------------------------------------------------------------
/backend/migrations/20221120224806_add_requests_table.js:
--------------------------------------------------------------------------------
 1 | exports.up = function (knex) {
 2 |   return knex.schema.createTable("requests", (table) => {
 3 |     table.increments("id").notNullable().primary();
 4 |     table.string("from").notNullable().references("email").inTable("users");
 5 |     table.string("to").notNullable().references("email").inTable("users");
 6 |     table.text("message", "text");
 7 |     table.boolean("accepted");
 8 |   });
 9 | };
10 | exports.down = function (knex) {
11 |   return knex.schema.dropTable("requests");
12 | };
13 | 


--------------------------------------------------------------------------------
/frontend/src/components/common/SearchField.jsx:
--------------------------------------------------------------------------------
 1 | export const SearchField = ({ value, setValue }) => (
 2 |   <>
 3 |     <div className="form-group form-label rounded-pill fw-bold">
 4 |       <input
 5 |         type="text"
 6 |         name="value"
 7 |         placeholder="Search for Name or City"
 8 |         id="username"
 9 |         className="form-control"
10 |         autoComplete="off"
11 |         required
12 |         value={value}
13 |         onChange={(event) => setValue(event.target.value)}
14 |       />
15 |     </div>
16 |   </>
17 | );
18 | 


--------------------------------------------------------------------------------
/backend/migrations/20221101182132_add_users_table.js:
--------------------------------------------------------------------------------
 1 | exports.up = function (knex) {
 2 |   return knex.schema.createTable("users", (table) => {
 3 |     table.string("email").notNullable().primary();
 4 |     table.string("password").notNullable();
 5 |     table.text("refreshToken", "text");
 6 |     table.text("photoID", "text");
 7 |     table.string("name");
 8 |     table.integer("age");
 9 |     table.string("city");
10 |     table.text("bio", "text");
11 |     table.string("gender");
12 |     table.integer("desired_roommates");
13 |     table.boolean("hasResidence");
14 |   });
15 | };
16 | exports.down = function (knex) {
17 |   return knex.schema.dropTable("users");
18 | };
19 | 


--------------------------------------------------------------------------------
/frontend/src/components/common/TextField.jsx:
--------------------------------------------------------------------------------
 1 | export const TextField = ({ label, id, value, setValue, required }) => (
 2 |   <>
 3 |     <div className="form-group fw-bold mb-3">
 4 |       <label htmlFor={id}>
 5 |         {label}&nbsp;
 6 |         {required && value !== null && value.length === 0 && (
 7 |           <span className="text text-danger">- {label} is required.</span>
 8 |         )}
 9 |       </label>
10 |       <input
11 |         type="text"
12 |         name="value"
13 |         id={id}
14 |         className="form-control"
15 |         autoComplete="off"
16 |         value={value}
17 |         onChange={(event) => setValue(event.target.value)}
18 |       />
19 |     </div>
20 |   </>
21 | );
22 | 


--------------------------------------------------------------------------------
/frontend/src/components/common/PlainNavBar.jsx:
--------------------------------------------------------------------------------
 1 | import { Link, NavLink } from "react-router-dom";
 2 | 
 3 | export const PlainNavBar = () => {
 4 |   return (
 5 |     <>
 6 |       <nav className="navbar navbar-expand-md sticky-top navbar-dark bg-dark shadow">
 7 |         <div className="container-fluid">
 8 |           <Link to={`/`} className=" navbar-brand fw-bold">
 9 |             <img src="/images/branding.png" alt="Mate Match" id="nav-image" />
10 |           </Link>
11 |           <div className="navbar-nav justify-content-end">
12 |             <NavLink to={`/login`} className="nav-link">
13 |               Sign In
14 |             </NavLink>
15 |           </div>
16 |         </div>
17 |       </nav>
18 |     </>
19 |   );
20 | };
21 | 


--------------------------------------------------------------------------------
/backend/controllers/authController.js:
--------------------------------------------------------------------------------
 1 | const jwt = require("jsonwebtoken");
 2 | const User = require("../models/user");
 3 | 
 4 | const handleLogin = async (email, password) => {
 5 |   const user = await User.authenticateUser(email, password);
 6 |   if (!user) {
 7 |     return { accessToken: null, refreshToken: null };
 8 |   }
 9 |   const users = await User.findUserByEmail(email);
10 | 
11 |   const accessToken = jwt.sign(
12 |     { email: users[0].email },
13 |     process.env.ACCESS_TOKEN_SECRET,
14 |     { expiresIn: "15m" }
15 |   );
16 |   const refreshToken = jwt.sign(
17 |     { email: users[0].email },
18 |     process.env.REFRESH_TOKEN_SECRET,
19 |     { expiresIn: "2d" }
20 |   );
21 |   await User.createRefreshToken(email, refreshToken);
22 | 
23 |   return { accessToken, refreshToken };
24 | };
25 | 
26 | module.exports = { handleLogin };
27 | 


--------------------------------------------------------------------------------
/frontend/src/api/AccountApi.js:
--------------------------------------------------------------------------------
 1 | import axios from "./axios";
 2 | 
 3 | export const handleLogin = (username, password) =>
 4 |   new Promise((resolve, reject) => {
 5 |     axios
 6 |       .post(
 7 |         `/session`,
 8 |         { email: username, password: password },
 9 |         {
10 |           headers: { "Content-Type": "application/json" },
11 |           withCredentials: true,
12 |         }
13 |       )
14 |       .then((x) => resolve(x.data))
15 |       .catch((x) => {
16 |         alert(x);
17 |         reject(x);
18 |       });
19 |   });
20 | 
21 | export const registerAccount = (username, password) =>
22 |   new Promise((resolve, reject) => {
23 |     axios
24 |       .post(`/register`, { email: username, password: password })
25 |       .then((x) => resolve(x.data))
26 |       .catch((x) => {
27 |         alert(x);
28 |         reject(x);
29 |       });
30 |   });
31 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Routing/Missing.jsx:
--------------------------------------------------------------------------------
 1 | import { Link } from "react-router-dom";
 2 | import { useAuth } from "../../../hooks";
 3 | import { NavBar } from "./NavBar";
 4 | import { PlainNavBar } from "../../common";
 5 | 
 6 | export const Missing = () => {
 7 |   const { auth } = useAuth();
 8 | 
 9 |   return (
10 |     <>
11 |       {auth?.username ? <NavBar /> : <PlainNavBar />}
12 |       <div className="container pt-4 pb-5 mb-4">
13 |         <div className="bg-light rounded p-3 p-md-5 pb-4 mb-4">
14 |           <h1 className="display-5">
15 |             <span className="fw-bold">404 Page not found</span>
16 |           </h1>
17 |           {auth?.username ? (
18 |             <Link to={`/dashboard`}>Return to the Dashboard</Link>
19 |           ) : (
20 |             <Link to={`/`}>Return to Home</Link>
21 |           )}
22 |         </div>
23 |       </div>
24 |     </>
25 |   );
26 | };
27 | 


--------------------------------------------------------------------------------
/backend/migrations/20221110205801_add_preferences_table.js:
--------------------------------------------------------------------------------
 1 | exports.up = function (knex) {
 2 |   return knex.schema.createTable("preferences", (table) => {
 3 |     table
 4 |       .string("email")
 5 |       .notNullable()
 6 |       .references("email")
 7 |       .inTable("users")
 8 |       .primary();
 9 |     table.boolean("apartment");
10 |     table.boolean("house");
11 |     table.boolean("condo");
12 |     table.boolean("nightPerson");
13 |     table.boolean("morningPerson");
14 |     table.boolean("extrovert");
15 |     table.boolean("introvert");
16 |     table.boolean("smoker");
17 |     table.boolean("bringFriendsOver");
18 |     table.boolean("loud");
19 |     table.boolean("shareFood");
20 |     table.boolean("messy");
21 |     table.boolean("pets");
22 |     table.boolean("relationship");
23 |   });
24 | };
25 | exports.down = function (knex) {
26 |   return knex.schema.dropTable("preferences");
27 | };
28 | 


--------------------------------------------------------------------------------
/backend/routes/roommate.js:
--------------------------------------------------------------------------------
 1 | const express = require("express");
 2 | const router = express.Router();
 3 | 
 4 | router.post("/", async (req, res, next) => {
 5 |   try {
 6 |     const body = req.body;
 7 | 
 8 |     const result = await req.models.roommate.addRoommate(
 9 |       body.person1,
10 |       body.person2
11 |     );
12 |     res.status(201).json(result);
13 |   } catch (err) {
14 |     console.error("Failed to add roommate to house:", err);
15 |     res.status(500).json({ message: err.toString() });
16 |   }
17 |   next();
18 | });
19 | 
20 | router.get("/", async (req, res, next) => {
21 |   if (req.query.email) {
22 |     const roommates = await req.models.roommate.getRoommates(req.query.email);
23 |     const roommatesWithAvatars = await req.models.avatar.getAvatarImages(
24 |       roommates
25 |     );
26 | 
27 |     res.json(roommatesWithAvatars);
28 |     next();
29 |   }
30 | });
31 | 
32 | module.exports = router;
33 | 


--------------------------------------------------------------------------------
/backend/controllers/refreshTokenController.js:
--------------------------------------------------------------------------------
 1 | const jwt = require("jsonwebtoken");
 2 | const User = require("../models/user");
 3 | 
 4 | const handleRefreshToken = async (cookies) => {
 5 |   const refreshToken = cookies.jwt;
 6 | 
 7 |   const users = await User.findUserByRT(refreshToken);
 8 |   if (users.length === 0) {
 9 |     return null;
10 |   }
11 | 
12 |   const result = jwt.verify(
13 |     refreshToken,
14 |     process.env.REFRESH_TOKEN_SECRET,
15 |     (err, decoded) => {
16 |       if (err || users[0].email !== decoded.email) {
17 |         return null;
18 |       }
19 |       const accessToken = jwt.sign(
20 |         { email: decoded.email },
21 |         process.env.ACCESS_TOKEN_SECRET,
22 |         { expiresIn: "15m" }
23 |       );
24 |       return { accessToken };
25 |     }
26 |   );
27 |   return { username: users[0].email, accessToken: result.accessToken };
28 | };
29 | 
30 | module.exports = { handleRefreshToken };
31 | 


--------------------------------------------------------------------------------
/backend/migrations/20221124033752_add_house_table.js:
--------------------------------------------------------------------------------
 1 | exports.up = function (knex) {
 2 |   return knex.schema.createTable("house", (table) => {
 3 |     table.increments("id").notNullable().primary();
 4 |     table.string("email1").references("email").inTable("users");
 5 |     table.string("email2").references("email").inTable("users");
 6 |     table.string("email3").references("email").inTable("users");
 7 |     table.string("email4").references("email").inTable("users");
 8 |     table.string("email5").references("email").inTable("users");
 9 |     table.string("email6").references("email").inTable("users");
10 |     table.string("email7").references("email").inTable("users");
11 |     table.string("email8").references("email").inTable("users");
12 |     table.string("email9").references("email").inTable("users");
13 |     table.string("email10").references("email").inTable("users");
14 |   });
15 | };
16 | exports.down = function (knex) {
17 |   return knex.schema.dropTable("house");
18 | };
19 | 


--------------------------------------------------------------------------------
/backend/routes/register.js:
--------------------------------------------------------------------------------
 1 | const express = require("express");
 2 | const router = express.Router();
 3 | 
 4 | router.post("/", async (req, res, next) => {
 5 |   try {
 6 |     const body = req.body;
 7 |     const result = await req.models.user.createUser(body.email, body.password);
 8 |     const pref = await req.models.user.addPref(
 9 |       body.email,
10 |       null,
11 |       null,
12 |       null,
13 |       null,
14 |       null,
15 |       null,
16 |       null,
17 |       null,
18 |       null,
19 |       null
20 |     );
21 |     res.status(201).json(result);
22 |   } catch (err) {
23 |     console.error("Failed to create new user:", err);
24 |     if (err.code === "ER_DUP_ENTRY") {
25 |       res.status(201).json({
26 |         message:
27 |           "Username already in use. Please use another username or login to your existing account.",
28 |       });
29 |     } else {
30 |       res.status(500).json({ message: err.toString() });
31 |     }
32 |   }
33 |   next();
34 | });
35 | 
36 | module.exports = router;
37 | 


--------------------------------------------------------------------------------
/backend/middleware/logEvents.js:
--------------------------------------------------------------------------------
 1 | const { format } = require("date-fns");
 2 | const { v4: uuid } = require("uuid");
 3 | 
 4 | const fs = require("fs");
 5 | const fsPromises = require("fs").promises;
 6 | const path = require("path");
 7 | 
 8 | const logEvents = async (message, logName) => {
 9 |   const dateTime = `${format(new Date(), "yyyyMMdd\tHH:mm:ss")}`;
10 |   const logItem = `${dateTime}\t${uuid()}\t${message}\n`;
11 | 
12 |   try {
13 |     if (!fs.existsSync(path.join(__dirname, "..", "logs"))) {
14 |       await fsPromises.mkdir(path.join(__dirname, "..", "logs"));
15 |     }
16 | 
17 |     await fsPromises.appendFile(
18 |       path.join(__dirname, "..", "logs", logName),
19 |       logItem
20 |     );
21 |   } catch (err) {
22 |     console.log(err);
23 |   }
24 | };
25 | 
26 | const logger = (req, res, next) => {
27 |   logEvents(`${req.method}\t${req.headers.origin}\t${req.url}`, "reqLog.txt");
28 |   console.log(`${req.method} ${req.path}`);
29 |   next();
30 | };
31 | 
32 | module.exports = { logger, logEvents };
33 | 


--------------------------------------------------------------------------------
/frontend/src/components/common/SelectField.jsx:
--------------------------------------------------------------------------------
 1 | export const SelectField = ({
 2 |   label,
 3 |   value,
 4 |   setValue,
 5 |   options,
 6 |   optionValueKey,
 7 |   optionLabelKey,
 8 |   hideBlankOption,
 9 | }) => (
10 |   <>
11 |     <div className="form-group fw-bold mb-3">
12 |       <label htmlFor="value">{label}</label>
13 |       <select
14 |         name="value"
15 |         id="value"
16 |         className="form-control"
17 |         value={value}
18 |         onChange={(event) => setValue(event.target.value)}
19 |       >
20 |         {!hideBlankOption && <option></option>}
21 |         {options.map((option, index) => (
22 |           <option
23 |             key={index}
24 |             value={optionValueKey ? option[optionValueKey] : option}
25 |           >
26 |             {optionLabelKey
27 |               ? option[optionLabelKey]
28 |               : optionValueKey
29 |               ? option[optionValueKey]
30 |               : option}
31 |           </option>
32 |         ))}
33 |       </select>
34 |     </div>
35 |   </>
36 | );
37 | 


--------------------------------------------------------------------------------
/backend/routes/avatar.js:
--------------------------------------------------------------------------------
 1 | const express = require("express");
 2 | const multer = require("multer");
 3 | const { v4: uuidv4 } = require("uuid");
 4 | const sharp = require("sharp");
 5 | 
 6 | const router = express.Router();
 7 | const storage = multer.memoryStorage();
 8 | const upload = multer({ storage: storage });
 9 | 
10 | router.post("/", upload.single("image"), async (req, res, next) => {
11 |   try {
12 |     if (!req.query.email) {
13 |       res.status(400).json({ message: "Missing email query parameter" });
14 |     }
15 | 
16 |     const file = req.file;
17 | 
18 |     const fileName = uuidv4();
19 |     const buffer = await sharp(file.buffer).resize(300, 300).toBuffer();
20 | 
21 |     const avatar = await req.models.avatar.addAvatarImage(
22 |       req.query.email,
23 |       req.query.photoID,
24 |       fileName,
25 |       buffer,
26 |       file.mimetype
27 |     );
28 | 
29 |     res.status(201).json(avatar);
30 |   } catch (err) {
31 |     console.error("Failed to upload image", err);
32 |     res.status(500).json({ message: err.toString() });
33 |   }
34 |   next();
35 | });
36 | 
37 | module.exports = router;
38 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Profile/AvatarUpload.jsx:
--------------------------------------------------------------------------------
 1 | import { useAxiosPrivate } from "../../../hooks";
 2 | 
 3 | export default function AvatarUpload({ username, photoID, onChange }) {
 4 |   const axiosPrivate = useAxiosPrivate();
 5 | 
 6 |   const uploadAvatar = async (event) => {
 7 |     event.preventDefault();
 8 | 
 9 |     const formData = new FormData();
10 |     formData.append("image", event.target.files[0]);
11 |     const photo = await axiosPrivate.post(
12 |       `/avatar?email=${username}&photoID=${photoID}`,
13 |       formData,
14 |       {
15 |         headers: { "Content-Type": "multipart/form-data" },
16 |       }
17 |     );
18 |     onChange(photo.data[0].photoID, photo.data[0].signedUrl);
19 |   };
20 | 
21 |   return (
22 |     <div>
23 |       <label htmlFor="avatar" className="btn btn-success">
24 |         Change Avatar
25 |       </label>
26 |       <div className="input-group">
27 |         <input
28 |           id="avatar"
29 |           onChange={(e) => uploadAvatar(e)}
30 |           type="file"
31 |           accept="image/*"
32 |           className="form-control d-none"
33 |         ></input>
34 |       </div>
35 |     </div>
36 |   );
37 | }
38 | 


--------------------------------------------------------------------------------
/frontend/src/components/common/CheckBoxDropdown.jsx:
--------------------------------------------------------------------------------
 1 | import { useState } from "react";
 2 | import { CheckBoxField } from "./CheckBoxField";
 3 | 
 4 | export const CheckBoxDropdown = ({ dd_label, options, setValues }) => {
 5 |   const [checked, setChecked] = useState(options);
 6 | 
 7 |   const handleToggle = (id) => {
 8 |     const newChecked = [...checked];
 9 |     newChecked[id].value = !newChecked[id].value;
10 | 
11 |     setChecked(newChecked);
12 |     setValues(newChecked);
13 |   };
14 | 
15 |   return (
16 |     <>
17 |       <div className="dropdown">
18 |         <button
19 |           className="btn btn-primary dropdown-toggle"
20 |           type="button"
21 |           data-bs-toggle="dropdown"
22 |           aria-expanded="false"
23 |         >
24 |           {dd_label}
25 |         </button>
26 |         <ul className="dropdown-menu">
27 |           {options.map((option, index) => (
28 |             <li className="ps-2 pe-0" key={index}>
29 |               <CheckBoxField
30 |                 label={option.display}
31 |                 checked={option.value}
32 |                 setChecked={() => handleToggle(index)}
33 |               />
34 |             </li>
35 |           ))}
36 |         </ul>
37 |       </div>
38 |     </>
39 |   );
40 | };
41 | 


--------------------------------------------------------------------------------
/backend/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "backend",
 3 |   "version": "1.0.0",
 4 |   "description": "",
 5 |   "main": "index.js",
 6 |   "scripts": {
 7 |     "start": "node index.js",
 8 |     "dev": "nodemon index.js",
 9 |     "test": "cross-env NODE_ENV=test jest --testTimeout=5000 --detectOpenHandles --forceExit",
10 |     "format": "prettier \"**/*.{js,jsx,css}\" --write"
11 |   },
12 |   "author": "",
13 |   "license": "ISC",
14 |   "dependencies": {
15 |     "@aws-sdk/client-cloudfront": "^3.353.0",
16 |     "@aws-sdk/client-s3": "^3.353.0",
17 |     "@aws-sdk/client-secrets-manager": "^3.354.0",
18 |     "@aws-sdk/cloudfront-signer": "^3.347.0",
19 |     "@aws-sdk/s3-request-presigner": "^3.353.0",
20 |     "@rama41222/node-logger": "^1.0.1",
21 |     "bcrypt": "^5.1.0",
22 |     "body-parser": "^1.20.1",
23 |     "cookie-parser": "^1.4.6",
24 |     "cors": "^2.8.5",
25 |     "date-fns": "^2.29.3",
26 |     "dotenv": "^16.0.3",
27 |     "express": "^4.18.2",
28 |     "jsonwebtoken": "^9.0.0",
29 |     "knex": "^2.3.0",
30 |     "multer": "^1.4.5-lts.1",
31 |     "mysql": "^2.18.1",
32 |     "sharp": "^0.32.1",
33 |     "uuid": "^9.0.0"
34 |   },
35 |   "devDependencies": {
36 |     "cross-env": "^7.0.3",
37 |     "jest": "^29.5.0",
38 |     "nodemon": "^2.0.15",
39 |     "prettier": "2.8.8",
40 |     "supertest": "^6.3.3"
41 |   }
42 | }
43 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Routing/PersistentLogin.jsx:
--------------------------------------------------------------------------------
 1 | import { Outlet } from "react-router-dom";
 2 | import { useState, useEffect } from "react";
 3 | import { useRefreshToken, useAuth } from "../../../hooks";
 4 | import { PlainNavBar } from "../../common";
 5 | 
 6 | export const PersistentLogin = () => {
 7 |   const [isLoading, setIsLoading] = useState(true);
 8 |   const refresh = useRefreshToken();
 9 |   const { auth } = useAuth();
10 | 
11 |   useEffect(() => {
12 |     let isMounted = true;
13 | 
14 |     const verifyRefreshToken = async () => {
15 |       try {
16 |         await refresh();
17 |       } catch (err) {
18 |         console.error(err);
19 |       } finally {
20 |         isMounted && setIsLoading(false);
21 |       }
22 |     };
23 |     !auth?.accessToken ? verifyRefreshToken() : setIsLoading(false);
24 |     return () => (isMounted = false);
25 |   }, []);
26 | 
27 |   return (
28 |     <>
29 |       {isLoading ? (
30 |         <>
31 |           <PlainNavBar />
32 |           <div className="container pt-4 pb-5 mb-4">
33 |             <div className="bg-light rounded p-3 p-md-5 pb-md-4 mb-4">
34 |               <div className="spinner-border" role="status">
35 |                 <span className="visually-hidden">Loading...</span>
36 |               </div>
37 |               <span className="fs-2 fw-bold">&nbsp;Loading...</span>
38 |             </div>
39 |           </div>
40 |         </>
41 |       ) : (
42 |         <Outlet />
43 |       )}
44 |     </>
45 |   );
46 | };
47 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Routing/Router.jsx:
--------------------------------------------------------------------------------
 1 | import { Route, Routes } from "react-router-dom";
 2 | import {
 3 |   LandingPage,
 4 |   RequireAuth,
 5 |   Registration,
 6 |   Login,
 7 |   Missing,
 8 |   ProfileExplorer,
 9 |   ProfileDetails,
10 |   ProfileEditor,
11 |   RoommateList,
12 |   RequestList,
13 |   PersistentLogin,
14 | } from "..";
15 | 
16 | export const Router = () => {
17 |   return (
18 |     <Routes>
19 |       <Route path="/">
20 |         {/* public routes */}
21 |         <Route path="/" element={<LandingPage />} exact />
22 |         <Route path="/login" element={<Login />} />
23 |         <Route path="/register" element={<Registration />} />
24 | 
25 |         {/* user routes */}
26 |         <Route element={<PersistentLogin />}>
27 |           <Route element={<RequireAuth />}>
28 |             <Route path="/dashboard" element={<ProfileExplorer />} />
29 |             <Route path="/requests" element={<RequestList />} />
30 |             <Route
31 |               path="/roommates"
32 |               element={<RoommateList standalone={true} />}
33 |             />
34 |             <Route path="/profile" element={<ProfileDetails />} />
35 |             <Route path="/profile/edit" element={<ProfileEditor />} />
36 |             <Route path="/:username/profile" element={<ProfileDetails />} />
37 |           </Route>
38 |           {/* catchall */}
39 |           <Route path="*" element={<Missing />} />
40 |         </Route>
41 |       </Route>
42 |     </Routes>
43 |   );
44 | };
45 | 


--------------------------------------------------------------------------------
/frontend/src/hooks/useAxiosPrivate.jsx:
--------------------------------------------------------------------------------
 1 | import { axiosPrivate } from "../api/axios";
 2 | import { useEffect } from "react";
 3 | import { useRefreshToken } from "./useRefreshToken";
 4 | import { useAuth } from "./useAuth";
 5 | 
 6 | export const useAxiosPrivate = () => {
 7 |   const refresh = useRefreshToken();
 8 |   const { auth } = useAuth();
 9 | 
10 |   useEffect(() => {
11 |     const requestIntercept = axiosPrivate.interceptors.request.use(
12 |       (config) => {
13 |         if (!config.headers["Authorization"]) {
14 |           config.headers["Authorization"] = `Bearer ${auth?.accessToken}`;
15 |         }
16 |         return config;
17 |       },
18 |       (error) => Promise.reject(error)
19 |     );
20 | 
21 |     const responseIntercept = axiosPrivate.interceptors.response.use(
22 |       (response) => response,
23 |       async (error) => {
24 |         const prevRequest = error?.config;
25 |         if (error?.response?.status === 403 && !prevRequest?.sent) {
26 |           prevRequest.sent = true;
27 |           const newAccessToken = await refresh();
28 |           prevRequest.headers["Authorization"] = `Bearer ${newAccessToken}`;
29 |           return axiosPrivate(prevRequest);
30 |         }
31 |         return Promise.reject(error);
32 |       }
33 |     );
34 | 
35 |     return () => {
36 |       axiosPrivate.interceptors.request.eject(requestIntercept);
37 |       axiosPrivate.interceptors.response.eject(responseIntercept);
38 |     };
39 |   }, [auth, refresh]);
40 | 
41 |   return axiosPrivate;
42 | };
43 | 


--------------------------------------------------------------------------------
/frontend/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "frontend",
 3 |   "version": "0.1.0",
 4 |   "private": true,
 5 |   "dependencies": {
 6 |     "@popperjs/core": "^2.11.6",
 7 |     "@testing-library/jest-dom": "^5.16.5",
 8 |     "@testing-library/react": "^13.4.0",
 9 |     "@testing-library/user-event": "^13.5.0",
10 |     "axios": "^1.0.0",
11 |     "bootstrap": "^5.2.2",
12 |     "bootstrap-icons": "^1.10.2",
13 |     "react": "^18.2.0",
14 |     "react-dom": "^18.2.0",
15 |     "react-router-dom": "^6.4.3",
16 |     "react-scripts": "5.0.1"
17 |   },
18 |   "scripts": {
19 |     "start": "react-scripts start",
20 |     "build": "react-scripts build",
21 |     "test": "react-scripts test",
22 |     "eject": "react-scripts eject",
23 |     "format": "prettier \"**/*.{js,jsx,css}\" --write",
24 |     "sync": "aws s3 sync ./build/ s3://matematching.com/",
25 |     "invalidate": "aws cloudfront create-invalidation --distribution-id EGZ28CI0X0FI2 --paths /*",
26 |     "deploy": "npm run build && npm run sync && npm run invalidate"
27 |   },
28 |   "eslintConfig": {
29 |     "extends": "react-app"
30 |   },
31 |   "browserslist": {
32 |     "production": [
33 |       ">0.2%",
34 |       "not dead",
35 |       "not op_mini all"
36 |     ],
37 |     "development": [
38 |       "last 1 chrome version",
39 |       "last 1 firefox version",
40 |       "last 1 safari version"
41 |     ]
42 |   },
43 |   "devDependencies": {
44 |     "prettier": "2.8.8"
45 |   },
46 |   "jest": {
47 |     "moduleNameMapper": {
48 |       "axios": "axios/dist/node/axios.cjs"
49 |     }
50 |   }
51 | }
52 | 


--------------------------------------------------------------------------------
/backend/index.js:
--------------------------------------------------------------------------------
 1 | const express = require("express");
 2 | const cors = require("cors");
 3 | const cookieParser = require("cookie-parser");
 4 | const corsOptions = require("./config/corsOptions");
 5 | 
 6 | const userRoutes = require("./routes/user");
 7 | const sessionRoutes = require("./routes/session");
 8 | const registerRoutes = require("./routes/register");
 9 | const requestRoutes = require("./routes/request");
10 | const roommateRoutes = require("./routes/roommate");
11 | const avatarRoutes = require("./routes/avatar");
12 | 
13 | const createModels = require("./middleware/createModels");
14 | const { logger } = require("./middleware/logEvents");
15 | const errorHandler = require("./middleware/errorHandler");
16 | const verifyJWT = require("./middleware/verifyJWT");
17 | const credentials = require("./middleware/credentials");
18 | 
19 | const app = express();
20 | const PORT = 8000;
21 | const server = app.listen(PORT, () => {
22 |   console.log(`This app is listening on port ${PORT}`);
23 | });
24 | 
25 | app.use(createModels);
26 | app.use(logger);
27 | app.use(express.json());
28 | app.use(cookieParser());
29 | app.use(credentials);
30 | app.use(cors(corsOptions));
31 | 
32 | app.use("/session", sessionRoutes);
33 | app.use("/register", registerRoutes);
34 | app.use("/user", verifyJWT, userRoutes);
35 | app.use("/request", verifyJWT, requestRoutes);
36 | app.use("/roommate", verifyJWT, roommateRoutes);
37 | app.use("/avatar", verifyJWT, avatarRoutes);
38 | 
39 | app.get("/", (req, res) => {
40 |   res.send("Healthy");
41 | });
42 | 
43 | app.use(errorHandler);
44 | 
45 | module.exports = server;
46 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Dashboard/ProfileExplorer.jsx:
--------------------------------------------------------------------------------
 1 | import { useState, useEffect } from "react";
 2 | import { useNavigate, useLocation } from "react-router-dom";
 3 | import { useAuth, useAxiosPrivate } from "../../../hooks";
 4 | import { ProfileSearch, ResultList } from "../Dashboard";
 5 | 
 6 | export const ProfileExplorer = () => {
 7 |   const { auth } = useAuth();
 8 |   const axiosPrivate = useAxiosPrivate();
 9 |   const navigate = useNavigate();
10 |   const location = useLocation();
11 | 
12 |   const [profiles, setProfiles] = useState([]);
13 |   const [searchResults, setSearchResults] = useState([]);
14 | 
15 |   useEffect(() => {
16 |     const getUsers = async () => {
17 |       try {
18 |         const response = await axiosPrivate.get("/user");
19 |         return response.data;
20 |       } catch (err) {
21 |         console.error(err);
22 |         navigate("/login", { state: { from: location }, replace: true });
23 |       }
24 |     };
25 |     getUsers().then((x) => {
26 |       setProfiles(
27 |         x.filter((y) => y.email !== auth.username && y.name !== null)
28 |       );
29 |       setSearchResults(
30 |         x.filter((y) => y.email !== auth.username && y.name !== null)
31 |       );
32 |     });
33 |   }, []);
34 | 
35 |   return (
36 |     <>
37 |       <div className="container pt-4 pb-5 mb-4">
38 |         <div className="bg-light rounded p-3 p-md-5 pb-4 mb-4">
39 |           <ProfileSearch
40 |             profiles={profiles}
41 |             setSearchResults={setSearchResults}
42 |           />
43 |           <ResultList results={searchResults} />
44 |         </div>
45 |       </div>
46 |     </>
47 |   );
48 | };
49 | 


--------------------------------------------------------------------------------
/backend/models/request.js:
--------------------------------------------------------------------------------
 1 | const knex = require("../config/knex");
 2 | const USERS_TABLE = "users";
 3 | const REQ_TABLE = "requests";
 4 | 
 5 | const fetchAllReq = async () => {
 6 |   const query = knex(REQ_TABLE);
 7 |   const results = await query;
 8 |   return results;
 9 | };
10 | 
11 | const fetchReqByRecipient = async (to) => {
12 |   const query = knex(REQ_TABLE)
13 |     .where({ to })
14 |     .crossJoin(USERS_TABLE, "users.email", "requests.from");
15 |   const results = await query;
16 |   return results;
17 | };
18 | 
19 | const fetchReqBySender = async (from) => {
20 |   const query = knex(REQ_TABLE)
21 |     .where({ from })
22 |     .crossJoin(USERS_TABLE, "users.email", "requests.to");
23 |   const results = await query;
24 |   return results;
25 | };
26 | 
27 | const fetchReq = async (to, from) => {
28 |   const query = knex(REQ_TABLE).where({ to, from });
29 |   const results = await query;
30 |   return results;
31 | };
32 | 
33 | const createRequest = async (to, from, message) => {
34 |   const query = knex(REQ_TABLE).insert({ to, from, message });
35 |   const result = await query;
36 |   return result;
37 | };
38 | 
39 | const acceptRequest = async (to, from, accepted) => {
40 |   const query = knex(REQ_TABLE).update({ accepted }).where({ to, from });
41 |   const results = await query;
42 |   return results;
43 | };
44 | 
45 | const deleteRequest = async (to, from) => {
46 |   const query = knex(REQ_TABLE).delete().where({ to, from });
47 |   const results = await query;
48 |   return results;
49 | };
50 | 
51 | module.exports = {
52 |   fetchAllReq,
53 |   fetchReqByRecipient,
54 |   fetchReqBySender,
55 |   fetchReq,
56 |   createRequest,
57 |   acceptRequest,
58 |   deleteRequest,
59 | };
60 | 


--------------------------------------------------------------------------------
/frontend/public/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <meta charset="utf-8" />
 5 |     <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
 6 |     <meta name="viewport" content="width=device-width, initial-scale=1" />
 7 |     <meta name="theme-color" content="#000000" />
 8 |     <meta
 9 |       name="description"
10 |       content="Find your new roommates today!"
11 |     />
12 |     <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
13 |     
14 |     <link href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.0/font/bootstrap-icons.css" rel="stylesheet" type="text/css" />
15 |     <!--
16 |       manifest.json provides metadata used when your web app is installed on a
17 |       user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
18 |     -->
19 |     <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
20 |     <!--
21 |       Notice the use of %PUBLIC_URL% in the tags above.
22 |       It will be replaced with the URL of the `public` folder during the build.
23 |       Only files inside the `public` folder can be referenced from the HTML.
24 | 
25 |       Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
26 |       work correctly both with client-side routing and a non-root public URL.
27 |       Learn how to configure a non-root public URL by running `npm run build`.
28 |     -->
29 |     <title>MateMatch: Find Potential Roommates</title>
30 |   </head>
31 |   <body>
32 |     <div id="page-container">
33 |       <div id="content-wrap">
34 | 
35 |         <noscript>You need to enable JavaScript to run this app.</noscript>
36 |         <div id="root"></div>
37 | 
38 |       </div>
39 |     </div>
40 |   </body>
41 | </html>


--------------------------------------------------------------------------------
/frontend/src/components/common/CredentialsField.jsx:
--------------------------------------------------------------------------------
 1 | export const CredentialsField = ({
 2 |   label,
 3 |   id,
 4 |   value,
 5 |   setValue,
 6 |   setFocus,
 7 |   password = false,
 8 | }) => (
 9 |   <>
10 |     <div className="form-group fw-bold mb-3">
11 |       <label htmlFor={id}>{label}</label>
12 |       {password && setFocus && (
13 |         <input
14 |           type="password"
15 |           name="value"
16 |           id={id}
17 |           className="form-control"
18 |           autoComplete="off"
19 |           required
20 |           value={value}
21 |           onChange={(event) => setValue(event.target.value)}
22 |           onFocus={() => setFocus(true)}
23 |           onBlur={() => setFocus(false)}
24 |         />
25 |       )}
26 |       {password && !setFocus && (
27 |         <input
28 |           type="password"
29 |           name="value"
30 |           id={id}
31 |           className="form-control"
32 |           autoComplete="off"
33 |           required
34 |           value={value}
35 |           onChange={(event) => setValue(event.target.value)}
36 |         />
37 |       )}
38 |       {!password && setFocus && (
39 |         <input
40 |           type="text"
41 |           name="value"
42 |           id={id}
43 |           className="form-control"
44 |           autoComplete="off"
45 |           required
46 |           value={value}
47 |           onChange={(event) => setValue(event.target.value)}
48 |           onFocus={() => setFocus(true)}
49 |           onBlur={() => setFocus(false)}
50 |         />
51 |       )}
52 |       {!password && !setFocus && (
53 |         <input
54 |           type="text"
55 |           name="value"
56 |           id={id}
57 |           className="form-control"
58 |           autoComplete="off"
59 |           required
60 |           value={value}
61 |           onChange={(event) => setValue(event.target.value)}
62 |         />
63 |       )}
64 |     </div>
65 |   </>
66 | );
67 | 


--------------------------------------------------------------------------------
/backend/routes/session.js:
--------------------------------------------------------------------------------
 1 | const express = require("express");
 2 | const router = express.Router();
 3 | const authController = require("../controllers/authController");
 4 | const refreshTokenController = require("../controllers/refreshTokenController");
 5 | const logoutController = require("../controllers/logoutController");
 6 | 
 7 | router.post("/", async (req, res, next) => {
 8 |   try {
 9 |     const body = req.body;
10 | 
11 |     const result = await authController.handleLogin(body.email, body.password);
12 |     if (result.refreshToken) {
13 |       res.cookie("jwt", result.refreshToken, {
14 |         httpOnly: true,
15 |         sameSite: "None",
16 |         secure: true,
17 |         maxAge: 24 * 60 * 60 * 2000,
18 |       });
19 |     }
20 |     res.status(201).json(result.accessToken);
21 |   } catch (err) {
22 |     console.error("Failed to authenticate user:", err);
23 |     res.status(500).json({ message: err.toString() });
24 |   }
25 |   next();
26 | });
27 | 
28 | router.get("/refresh", async (req, res, next) => {
29 |   try {
30 |     if (!req.cookies?.jwt) return res.sendStatus(401);
31 | 
32 |     const result = await refreshTokenController.handleRefreshToken(req.cookies);
33 | 
34 |     if (!result) return res.sendStatus(403);
35 | 
36 |     res.status(201).json(result);
37 |   } catch (err) {
38 |     console.error("Failed to refresh session:", err);
39 |     res.status(500).json({ message: err.toString() });
40 |   }
41 |   next();
42 | });
43 | 
44 | router.get("/logout", async (req, res, next) => {
45 |   try {
46 |     if (!req.cookies?.jwt) return res.sendStatus(204);
47 | 
48 |     const result = await logoutController.handleLogout(req.cookies);
49 | 
50 |     res.clearCookie("jwt", { httpOnly: true, sameSite: "None", secure: true });
51 |     res.status(204).json(result);
52 |   } catch (err) {
53 |     console.error("Failed to logout:", err);
54 |     res.status(500).json({ message: err.toString() });
55 |   }
56 |   next();
57 | });
58 | 
59 | module.exports = router;
60 | 


--------------------------------------------------------------------------------
/.github/workflows/build.yml:
--------------------------------------------------------------------------------
 1 | name: Build and Test
 2 | 
 3 | on:
 4 |   pull_request:
 5 |     branches: [main]
 6 | 
 7 | jobs:
 8 |   build:
 9 |     runs-on: ubuntu-latest
10 |     steps:
11 |       - uses: actions/checkout@v3
12 |       - uses: actions/setup-node@v3
13 |         with:
14 |           node-version: 18
15 | 
16 |       - name: Install and Build React Client
17 |         working-directory: ./frontend
18 |         run: |
19 |           npm ci
20 |           npm run test
21 |         env:
22 |           REACT_APP_API_URL: ${{secrets.REACT_APP_API_URL}}
23 |           CI: false
24 | 
25 |       - name: Install and Build Express Server
26 |         working-directory: ./backend
27 |         run: |
28 |           npm ci
29 |           npm run test
30 |         env:
31 |           CLIENT_URL: ${{secrets.CLIENT_URL}}
32 |           MYSQL_DB: ${{secrets.MYSQL_DB}}
33 |           MYSQL_PORT: ${{secrets.MYSQL_PORT}}
34 |           MYSQL_CLOUD_USER: ${{secrets.MYSQL_CLOUD_USER}}
35 |           MYSQL_CLOUD_PASS: ${{secrets.MYSQL_CLOUD_PASS}}
36 |           MYSQL_CLOUD_HOST: ${{secrets.MYSQL_CLOUD_HOST}}
37 |           ACCESS_TOKEN_SECRET: ${{secrets.ACCESS_TOKEN_SECRET}}
38 |           REFRESH_TOKEN_SECRET: ${{secrets.REFRESH_TOKEN_SECRET}}
39 |           BUCKET_NAME: ${{secrets.BUCKET_NAME}}
40 |           BUCKET_REGION: ${{secrets.BUCKET_REGION}}
41 |           BUCKET_ACCESS_KEY: ${{secrets.BUCKET_ACCESS_KEY}}
42 |           BUCKET_SECRET_ACCESS_KEY: ${{secrets.BUCKET_SECRET_ACCESS_KEY}}
43 |           CLOUDFRONT_DISTRIBUTION_ID: ${{secrets.CLOUDFRONT_DISTRIBUTION_ID}}
44 |           CLOUDFRONT_KEY_PAIR_ID: ${{secrets.CLOUDFRONT_KEY_PAIR_ID}}
45 |           CLOUDFRONT_URL: ${{secrets.CLOUDFRONT_URL}}
46 |           SECRET_REGION: ${{secrets.SECRET_REGION}}
47 |           SECRET_SIGNING_KEY: ${{secrets.SECRET_SIGNING_KEY}}
48 |           AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
49 |           AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}
50 |           TEST_USERNAME: ${{secrets.TEST_USERNAME}}
51 |           TEST_PASSWORD: ${{secrets.TEST_PASSWORD}}
52 | 


--------------------------------------------------------------------------------
/backend/routes/request.js:
--------------------------------------------------------------------------------
 1 | const express = require("express");
 2 | const router = express.Router();
 3 | 
 4 | router.get("/", async (req, res, next) => {
 5 |   let requests;
 6 |   if (req.query.to && req.query.from) {
 7 |     requests = await req.models.request.fetchReq(req.query.to, req.query.from);
 8 |   } else if (req.query.to) {
 9 |     requests = await req.models.request.fetchReqByRecipient(req.query.to);
10 |     requests = await req.models.avatar.getAvatarImages(requests);
11 |   } else if (req.query.from) {
12 |     requests = await req.models.request.fetchReqBySender(req.query.from);
13 |     requests = await req.models.avatar.getAvatarImages(requests);
14 |   } else {
15 |     requests = await req.models.request.fetchAllReq();
16 |   }
17 |   res.json(requests);
18 |   next();
19 | });
20 | 
21 | router.post("/", async (req, res, next) => {
22 |   try {
23 |     const body = req.body;
24 |     const result = await req.models.request.createRequest(
25 |       body.to,
26 |       body.from,
27 |       body.message
28 |     );
29 |     res.status(201).json(result);
30 |   } catch (err) {
31 |     console.error("Failed to create new request:", err);
32 |     res.status(500).json({ message: err.toString() });
33 |   }
34 |   next();
35 | });
36 | 
37 | router.delete("/", async (req, res, next) => {
38 |   try {
39 |     const deleteReq = await req.models.request.deleteRequest(
40 |       req.query.to,
41 |       req.query.from
42 |     );
43 |     res.status(204).end();
44 |   } catch (err) {
45 |     console.error("Failed to delete request:", err);
46 |     res.status(500).json({ message: err.toString() });
47 |   }
48 |   next();
49 | });
50 | 
51 | router.put("/", async (req, res, next) => {
52 |   try {
53 |     const acceptReq = await req.models.request.acceptRequest(
54 |       req.body.to,
55 |       req.body.from,
56 |       req.body.accepted
57 |     );
58 |     res.json(acceptReq);
59 |   } catch (err) {
60 |     console.error("Failed to accept request:", err);
61 |     res.status(500).json({ message: err.toString() });
62 |   }
63 |   next();
64 | });
65 | 
66 | module.exports = router;
67 | 


--------------------------------------------------------------------------------
/.github/workflows/deploy.yml:
--------------------------------------------------------------------------------
 1 | name: Deploy
 2 | 
 3 | on:
 4 |   push:
 5 |     branches: [main]
 6 | 
 7 | jobs:
 8 |   deploy-frontend:
 9 |     if: '!contains(github.event.head_commit.message, "docs:") && !contains(github.event.head_commit.message, "ci:")'
10 |     runs-on: ubuntu-latest
11 |     steps:
12 |       - uses: actions/checkout@v3
13 |       - uses: actions/setup-node@v3
14 |         with:
15 |           node-version: 18
16 | 
17 |       - name: Configure AWS credentials
18 |         uses: aws-actions/configure-aws-credentials@v1
19 |         with:
20 |           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
21 |           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
22 |           aws-region: us-east-1
23 | 
24 |       - name: Deploy React Client to S3
25 |         working-directory: ./frontend
26 |         run: |
27 |           npm ci
28 |           npm run deploy
29 |         env:
30 |           REACT_APP_API_URL: ${{ secrets.REACT_APP_API_URL }}
31 |           CI: false
32 | 
33 |   deploy-backend:
34 |     if: '!contains(github.event.head_commit.message, "docs:") && !contains(github.event.head_commit.message, "ci:")'
35 |     runs-on: ubuntu-latest
36 |     steps:
37 |       - uses: actions/checkout@v3
38 |       - uses: actions/setup-node@v3
39 |         with:
40 |           node-version: 18
41 | 
42 |       - name: Configure AWS credentials
43 |         uses: aws-actions/configure-aws-credentials@v1
44 |         with:
45 |           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
46 |           aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
47 |           aws-region: us-east-1
48 | 
49 |       - name: Login to Amazon ECR
50 |         id: login-ecr
51 |         uses: aws-actions/amazon-ecr-login@v1
52 | 
53 |       - name: Build, Tag, and Push the Image to Amazon ECR
54 |         working-directory: ./backend
55 |         id: build-image
56 |         env:
57 |           ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
58 |           ECR_REPOSITORY: matematch-api-ecr
59 |           IMAGE_TAG: latest
60 |         run: |
61 |           docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
62 |           docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
63 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Dashboard/ResultList.jsx:
--------------------------------------------------------------------------------
 1 | import { Link } from "react-router-dom";
 2 | 
 3 | export const ResultList = ({ results }) => {
 4 |   return (
 5 |     <>
 6 |       <h3>
 7 |         Profiles
 8 |         <span className="text-secondary"> ({results.length})</span>
 9 |       </h3>
10 |       {results.length === 0 ? (
11 |         <p className="bg-light rounded p-3">No Matching Profiles</p>
12 |       ) : (
13 |         <div className="row g-3">
14 |           {results.map((result, index) => (
15 |             <div key={index} className="col-md-6 col-xl-4">
16 |               <div className="card card-height">
17 |                 <div className="card-image">
18 |                   <img
19 |                     src={
20 |                       result.signedUrl
21 |                         ? result.signedUrl
22 |                         : "/images/default.jpg"
23 |                     }
24 |                     alt="avatar"
25 |                     className="card-img-top"
26 |                   />
27 |                 </div>
28 |                 <div className="card-body d-flex flex-column justify-content-between">
29 |                   <div>
30 |                     <div className="row">
31 |                       <div className="col pe-0">
32 |                         <div className="card-title fw-bold fs-4">
33 |                           {result.name}
34 |                         </div>
35 |                       </div>
36 |                       <div className="col ps-0">
37 |                         <div className="my-1 fs-5 fw-light text-muted text-end">
38 |                           {result.city} - {result.age}
39 |                         </div>
40 |                       </div>
41 |                     </div>
42 |                   </div>
43 |                   <div className="mt-auto">
44 |                     <Link
45 |                       to={`/${result.email}/profile`}
46 |                       className="btn btn-primary btn-lg col-12"
47 |                     >
48 |                       View Profile
49 |                     </Link>
50 |                   </div>
51 |                 </div>
52 |               </div>
53 |             </div>
54 |           ))}
55 |         </div>
56 |       )}
57 |     </>
58 |   );
59 | };
60 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Account/Login.jsx:
--------------------------------------------------------------------------------
 1 | import { useState, useEffect } from "react";
 2 | import { Link, useNavigate } from "react-router-dom";
 3 | import { handleLogin } from "../../../api";
 4 | import { useAuth } from "../../../hooks";
 5 | import { CredentialsField, PlainNavBar } from "../../common";
 6 | 
 7 | export const Login = () => {
 8 |   const { setAuth } = useAuth();
 9 |   const navigate = useNavigate();
10 | 
11 |   const [username, setUserName] = useState("");
12 |   const [password, setPassword] = useState("");
13 |   const [errorMessage, setErrorMessage] = useState("");
14 | 
15 |   useEffect(() => {
16 |     setErrorMessage("");
17 |   }, [username, password]);
18 | 
19 |   const handleSubmit = async (e) => {
20 |     e.preventDefault();
21 | 
22 |     handleLogin(username, password).then((accessToken) => {
23 |       if (accessToken != null) {
24 |         setAuth({ username, accessToken });
25 |         setUserName("");
26 |         setPassword("");
27 |         navigate(`/dashboard`);
28 |       } else {
29 |         setErrorMessage("Unsuccessful login attempt. Please try again.");
30 |       }
31 |     });
32 |   };
33 | 
34 |   return (
35 |     <>
36 |       <PlainNavBar />
37 |       <div className="container pt-4 pb-5 mb-4">
38 |         <div className="bg-light rounded mx-auto col-xl-6 p-3 p-md-5 pb-md-3 mb-4">
39 |           <div className={errorMessage ? "alert alert-danger" : "d-none"}>
40 |             {errorMessage}
41 |           </div>
42 |           <h1>Sign In</h1>
43 |           <CredentialsField
44 |             label="Username:"
45 |             id="username"
46 |             value={username}
47 |             setValue={(name) => setUserName(name)}
48 |           />
49 |           <CredentialsField
50 |             label="Password:"
51 |             password={true}
52 |             id="password"
53 |             value={password}
54 |             setValue={(pwd) => setPassword(pwd)}
55 |           />
56 |           <button
57 |             type="button"
58 |             className="btn btn-primary btn-lg col-12 mt-1 mb-2"
59 |             onClick={handleSubmit}
60 |           >
61 |             Sign In
62 |           </button>
63 |           <hr />
64 |           <p className="mt-1">
65 |             Don't have an account?&nbsp;
66 |             <Link to={`/register`}>Create an account</Link>
67 |           </p>
68 |         </div>
69 |       </div>
70 |     </>
71 |   );
72 | };
73 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Routing/NavBar.jsx:
--------------------------------------------------------------------------------
 1 | import { Link, NavLink, useNavigate } from "react-router-dom";
 2 | import { useLogout } from "../../../hooks";
 3 | 
 4 | export const NavBar = () => {
 5 |   const navigate = useNavigate();
 6 |   const logout = useLogout();
 7 | 
 8 |   const handleLogout = async () => {
 9 |     await logout();
10 |     navigate("/");
11 |   };
12 | 
13 |   return (
14 |     <>
15 |       <nav className="navbar navbar-expand-md sticky-top navbar-dark bg-dark shadow">
16 |         <div className="container-fluid">
17 |           <Link to={`dashboard`} className=" navbar-brand fw-bold">
18 |             <img src="/images/branding.png" alt="Mate Match" id="nav-image" />
19 |           </Link>
20 |           <button
21 |             className="navbar-toggler"
22 |             type="button"
23 |             data-bs-toggle="collapse"
24 |             data-bs-target="#navbarNavAltMarkup"
25 |           >
26 |             <span className="navbar-toggler-icon"></span>
27 |           </button>
28 |           <div
29 |             className="collapse navbar-collapse justify-content-end"
30 |             id="navbarNavAltMarkup"
31 |           >
32 |             <div className="navbar-nav">
33 |               <NavLink to={`requests`} className="nav-link">
34 |                 Your Requests
35 |               </NavLink>
36 |               <NavLink to={`roommates`} className="nav-link">
37 |                 Your Roommates
38 |               </NavLink>
39 |               <div className="nav-item dropdown-center">
40 |                 <div
41 |                   className="nav-link dropdown-toggle"
42 |                   role="button"
43 |                   data-bs-toggle="dropdown"
44 |                 >
45 |                   Your Account
46 |                 </div>
47 |                 <ul id="navbar-dropdown" className="dropdown-menu m-0">
48 |                   <li className="ps-3 pe-4">
49 |                     <Link
50 |                       to={`profile/edit`}
51 |                       className="dropdown-item py-0 px-0"
52 |                     >
53 |                       Edit Profile
54 |                     </Link>
55 |                   </li>
56 |                   <li>
57 |                     <hr className="dropdown-divider" />
58 |                   </li>
59 |                   <li className="ps-3 pe-4">
60 |                     <Link to={`profile`} className="dropdown-item py-0 px-0">
61 |                       View Profile
62 |                     </Link>
63 |                   </li>
64 |                   <li>
65 |                     <hr className="dropdown-divider" />
66 |                   </li>
67 |                   <li className="ps-3 pe-4">
68 |                     <button
69 |                       className="dropdown-item py-0 px-0"
70 |                       onClick={handleLogout}
71 |                     >
72 |                       Sign Out
73 |                     </button>
74 |                   </li>
75 |                 </ul>
76 |               </div>
77 |             </div>
78 |           </div>
79 |         </div>
80 |       </nav>
81 |     </>
82 |   );
83 | };
84 | 


--------------------------------------------------------------------------------
/backend/tests/api.test.js:
--------------------------------------------------------------------------------
  1 | const request = require("supertest");
  2 | const server = require("../index");
  3 | 
  4 | require("dotenv").config();
  5 | 
  6 | afterEach(async () => {
  7 |   server.close();
  8 | });
  9 | 
 10 | describe("POST /session", () => {
 11 |   it("create login session", async () => {
 12 |     const token = await request(server)
 13 |       .post("/session")
 14 |       .send({
 15 |         email: process.env.TEST_USERNAME,
 16 |         password: process.env.TEST_PASSWORD,
 17 |       })
 18 |       .set({
 19 |         Origin: "https://matematching.com",
 20 |         "Content-Type": "application/json",
 21 |         withCredentials: true,
 22 |       });
 23 | 
 24 |     expect(token.statusCode).toBe(201);
 25 |   });
 26 | });
 27 | 
 28 | describe("GET /user", () => {
 29 |   it("gets all users", async () => {
 30 |     const token = await request(server)
 31 |       .post("/session")
 32 |       .send({
 33 |         email: process.env.TEST_USERNAME,
 34 |         password: process.env.TEST_PASSWORD,
 35 |       })
 36 |       .set({
 37 |         Origin: "https://matematching.com",
 38 |         "Content-Type": "application/json",
 39 |         withCredentials: true,
 40 |       });
 41 | 
 42 |     expect(token.statusCode).toBe(201);
 43 | 
 44 |     const response = await request(server)
 45 |       .get("/user")
 46 |       .set({
 47 |         Origin: "https://matematching.com",
 48 |         Authorization: "Bearer " + token.body,
 49 |         "Content-Type": "application/json",
 50 |       });
 51 | 
 52 |     expect(response.statusCode).toBe(200);
 53 |     expect(Array.isArray(response.body)).toBe(true);
 54 |   });
 55 | });
 56 | 
 57 | describe("GET /request", () => {
 58 |   it("gets requests from current user", async () => {
 59 |     const token = await request(server)
 60 |       .post("/session")
 61 |       .send({
 62 |         email: process.env.TEST_USERNAME,
 63 |         password: process.env.TEST_PASSWORD,
 64 |       })
 65 |       .set({
 66 |         Origin: "https://matematching.com",
 67 |         "Content-Type": "application/json",
 68 |         withCredentials: true,
 69 |       });
 70 | 
 71 |     expect(token.statusCode).toBe(201);
 72 | 
 73 |     const response = await request(server)
 74 |       .get("/request")
 75 |       .query({ from: process.env.TEST_USERNAME })
 76 |       .set({
 77 |         Origin: "https://matematching.com",
 78 |         Authorization: "Bearer " + token.body,
 79 |         "Content-Type": "application/json",
 80 |       });
 81 | 
 82 |     expect(response.statusCode).toBe(200);
 83 |     expect(Array.isArray(response.body)).toBe(true);
 84 |   });
 85 | });
 86 | 
 87 | describe("GET /roommate", () => {
 88 |   it("gets a user's roommates", async () => {
 89 |     const token = await request(server)
 90 |       .post("/session")
 91 |       .send({
 92 |         email: process.env.TEST_USERNAME,
 93 |         password: process.env.TEST_PASSWORD,
 94 |       })
 95 |       .set({
 96 |         Origin: "https://matematching.com",
 97 |         "Content-Type": "application/json",
 98 |         withCredentials: true,
 99 |       });
100 | 
101 |     expect(token.statusCode).toBe(201);
102 | 
103 |     const response = await request(server)
104 |       .get("/roommate")
105 |       .query({ email: process.env.TEST_USERNAME })
106 |       .set({
107 |         Origin: "https://matematching.com",
108 |         Authorization: "Bearer " + token.body,
109 |         "Content-Type": "application/json",
110 |       });
111 | 
112 |     expect(response.statusCode).toBe(200);
113 |     expect(Array.isArray(response.body)).toBe(true);
114 |   });
115 | });
116 | 


--------------------------------------------------------------------------------
/backend/routes/user.js:
--------------------------------------------------------------------------------
  1 | const express = require("express");
  2 | const router = express.Router();
  3 | 
  4 | router.get("/", async (req, res, next) => {
  5 |   let users;
  6 |   if (req.query.name) {
  7 |     users = await req.models.user.fetchUserByName(req.query.name);
  8 |   } else if (req.query.email) {
  9 |     users = await req.models.user.findUserByEmail(req.query.email);
 10 |   } else {
 11 |     users = await req.models.user.fetchAllUsers();
 12 |   }
 13 |   usersWithAvatars = await req.models.avatar.getAvatarImages(users);
 14 |   res.json(usersWithAvatars);
 15 |   next();
 16 | });
 17 | 
 18 | router.post("/", async (req, res, next) => {
 19 |   try {
 20 |     const body = req.body;
 21 |     const result = await req.models.user.createNewUser(
 22 |       body.email,
 23 |       body.password
 24 |     );
 25 |     res.status(201).json(result);
 26 |   } catch (err) {
 27 |     console.error("Failed to create new user:", err);
 28 |     res.status(500).json({ message: err.toString() });
 29 |   }
 30 |   next();
 31 | });
 32 | 
 33 | router.put("/", async (req, res, next) => {
 34 |   try {
 35 |     const updateUser = await req.models.user.updateUser(
 36 |       req.body.email,
 37 |       req.body.photoID,
 38 |       req.body.name,
 39 |       req.body.age,
 40 |       req.body.city,
 41 |       req.body.bio,
 42 |       req.body.gender,
 43 |       req.body.desired_roommates,
 44 |       req.body.hasResidence
 45 |     );
 46 |     res.json(updateUser);
 47 |   } catch (err) {
 48 |     console.error("Failed to update user:", err);
 49 |     res.status(500).json({ message: err.toString() });
 50 |   }
 51 |   next();
 52 | });
 53 | 
 54 | router.post("/preferences", async (req, res, next) => {
 55 |   const addPrefstoUser = await req.models.user.addPref(
 56 |     req.body.email,
 57 |     req.body.apartment,
 58 |     req.body.house,
 59 |     req.body.condo,
 60 |     req.body.nightPerson,
 61 |     req.body.morningPerson,
 62 |     req.body.extrovert,
 63 |     req.body.introvert,
 64 |     req.body.smoker,
 65 |     req.body.bringFriendsOver,
 66 |     req.body.loud,
 67 |     req.body.shareFood,
 68 |     req.body.messy,
 69 |     req.body.pets,
 70 |     req.body.relationship
 71 |   );
 72 |   res.json(addPrefstoUser);
 73 |   next();
 74 | });
 75 | 
 76 | router.get("/preferences", async (req, res, next) => {
 77 |   if (req.query.email) {
 78 |     const PrefByEmail = await req.models.user.findPrefByEmail(req.query.email);
 79 |     res.json(PrefByEmail);
 80 |     next();
 81 |   }
 82 | });
 83 | 
 84 | router.put("/preferences", async (req, res, next) => {
 85 |   try {
 86 |     const updateUser = await req.models.user.updatePref(
 87 |       req.body.email,
 88 |       req.body.apartment,
 89 |       req.body.house,
 90 |       req.body.condo,
 91 |       req.body.nightPerson,
 92 |       req.body.morningPerson,
 93 |       req.body.extrovert,
 94 |       req.body.introvert,
 95 |       req.body.smoker,
 96 |       req.body.bringFriendsOver,
 97 |       req.body.loud,
 98 |       req.body.shareFood,
 99 |       req.body.messy,
100 |       req.body.pets,
101 |       req.body.relationship
102 |     );
103 |     res.json(updateUser);
104 |   } catch (err) {
105 |     console.error("Failed to update user preferences:", err);
106 |     res.status(500).json({ message: err.toString() });
107 |   }
108 |   next();
109 | });
110 | 
111 | router.delete("/", async (req, res, next) => {
112 |   const deletePref = await req.models.user.deletePref(req.body.email);
113 |   const deleteUser = await req.models.user.deleteUser(req.body.email);
114 |   res.status(204).end();
115 |   next();
116 | });
117 | 
118 | module.exports = router;
119 | 


--------------------------------------------------------------------------------
/backend/models/avatar.js:
--------------------------------------------------------------------------------
  1 | const knex = require("../config/knex");
  2 | require("dotenv").config();
  3 | const {
  4 |   S3Client,
  5 |   PutObjectCommand,
  6 |   DeleteObjectCommand,
  7 | } = require("@aws-sdk/client-s3");
  8 | const {
  9 |   CloudFrontClient,
 10 |   CreateInvalidationCommand,
 11 | } = require("@aws-sdk/client-cloudfront");
 12 | const { getSignedUrl } = require("@aws-sdk/cloudfront-signer");
 13 | const {
 14 |   SecretsManagerClient,
 15 |   GetSecretValueCommand,
 16 | } = require("@aws-sdk/client-secrets-manager");
 17 | 
 18 | const USERS_TABLE = "users";
 19 | 
 20 | const bucketName = process.env.BUCKET_NAME;
 21 | const bucketRegion = process.env.BUCKET_REGION;
 22 | const bucketAccessKey = process.env.BUCKET_ACCESS_KEY;
 23 | const bucketSecretAccessKey = process.env.BUCKET_SECRET_ACCESS_KEY;
 24 | 
 25 | const cloudfrontDistributionId = process.env.CLOUDFRONT_DISTRIBUTION_ID;
 26 | const cloudfrontUrl = process.env.CLOUDFRONT_URL;
 27 | const cloudfrontKeyPairId = process.env.CLOUDFRONT_KEY_PAIR_ID;
 28 | 
 29 | const secretRegion = process.env.SECRET_REGION;
 30 | const secretSigningKey = process.env.SECRET_SIGNING_KEY;
 31 | 
 32 | const s3 = new S3Client({
 33 |   credentials: {
 34 |     accessKeyId: bucketAccessKey,
 35 |     secretAccessKey: bucketSecretAccessKey,
 36 |   },
 37 |   region: bucketRegion,
 38 | });
 39 | 
 40 | const cloudfront = new CloudFrontClient({
 41 |   credentials: {
 42 |     accessKeyId: bucketAccessKey,
 43 |     secretAccessKey: bucketSecretAccessKey,
 44 |   },
 45 | });
 46 | 
 47 | const secretsManager = new SecretsManagerClient({
 48 |   region: secretRegion,
 49 | });
 50 | 
 51 | const addAvatarImage = async (email, photoID, fileName, buffer, mimetype) => {
 52 |   if (photoID) {
 53 |     await removeAvatarImage(photoID);
 54 |   }
 55 | 
 56 |   const params = {
 57 |     Bucket: bucketName,
 58 |     Key: fileName,
 59 |     Body: buffer,
 60 |     ContentType: mimetype,
 61 |   };
 62 | 
 63 |   const command = new PutObjectCommand(params);
 64 | 
 65 |   await s3.send(command);
 66 | 
 67 |   await knex(USERS_TABLE).update({ photoID: fileName }).where({ email });
 68 | 
 69 |   const users = await knex(USERS_TABLE).select().where({ email });
 70 | 
 71 |   const result = await getAvatarImages(users);
 72 | 
 73 |   return result;
 74 | };
 75 | 
 76 | const getAvatarImages = async (users) => {
 77 |   const command = new GetSecretValueCommand({
 78 |     SecretId: secretSigningKey,
 79 |   });
 80 | 
 81 |   const secret = await secretsManager.send(command);
 82 | 
 83 |   for (const user of users) {
 84 |     if (user.photoID === null) continue;
 85 | 
 86 |     user.signedUrl = getSignedUrl({
 87 |       url: cloudfrontUrl + user.photoID,
 88 |       keyPairId: cloudfrontKeyPairId,
 89 |       dateLessThan: new Date(Date.now() + 60 * 60 * 1000),
 90 |       privateKey: secret.SecretString,
 91 |     });
 92 |   }
 93 |   return users;
 94 | };
 95 | 
 96 | const removeAvatarImage = async (photoID) => {
 97 |   const params = {
 98 |     Bucket: bucketName,
 99 |     Key: photoID,
100 |   };
101 | 
102 |   const command = new DeleteObjectCommand(params);
103 |   await s3.send(command);
104 | 
105 |   const invalidationParams = {
106 |     DistributionId: cloudfrontDistributionId,
107 |     InvalidationBatch: {
108 |       CallerReference: photoID,
109 |       Paths: {
110 |         Quantity: 1,
111 |         Items: [`/${photoID}`],
112 |       },
113 |     },
114 |   };
115 | 
116 |   const invalidationCommand = new CreateInvalidationCommand(invalidationParams);
117 |   await cloudfront.send(invalidationCommand);
118 | 
119 |   const query = knex(USERS_TABLE).update({ photoID: null }).where({ photoID });
120 |   return await query;
121 | };
122 | 
123 | module.exports = {
124 |   addAvatarImage,
125 |   getAvatarImages,
126 | };
127 | 


--------------------------------------------------------------------------------
/frontend/src/styles/styles.css:
--------------------------------------------------------------------------------
  1 | /* General */
  2 | 
  3 | #page-container {
  4 |   position: relative;
  5 |   min-height: 100vh;
  6 | }
  7 | 
  8 | #content-wrap {
  9 |   padding-bottom: 3.5rem;
 10 | }
 11 | 
 12 | /* Navbar */
 13 | 
 14 | .navbar-nav .nav-link.active {
 15 |   font-weight: 500;
 16 | }
 17 | 
 18 | #nav-image {
 19 |   position: relative;
 20 |   height: 2.2rem;
 21 |   overflow: hidden;
 22 | }
 23 | 
 24 | /* Footer */
 25 | 
 26 | footer {
 27 |   text-align: center;
 28 |   position: absolute;
 29 |   bottom: 0;
 30 |   width: 100%;
 31 | }
 32 | 
 33 | footer i {
 34 |   font-size: 1.75rem;
 35 | }
 36 | 
 37 | /* ProfileDetails avatar */
 38 | 
 39 | .avatar-image {
 40 |   position: relative;
 41 |   width: 12rem;
 42 |   height: 12rem;
 43 |   overflow: hidden;
 44 |   border-radius: 50%;
 45 |   margin: 0 auto;
 46 | }
 47 | 
 48 | .avatar-image .image-wrapper {
 49 |   position: relative;
 50 |   width: 100%;
 51 |   height: 100%;
 52 |   display: flex;
 53 |   justify-content: center;
 54 |   align-items: center;
 55 | }
 56 | 
 57 | .avatar-image .image-wrapper img {
 58 |   width: 100%;
 59 |   height: auto;
 60 |   object-fit: cover; /* Ensures the image covers the entire circular container while maintaining aspect ratio */
 61 | }
 62 | 
 63 | .avatar-image .image-wrapper .overlay {
 64 |   position: absolute;
 65 |   top: 0;
 66 |   left: 0;
 67 |   width: 100%;
 68 |   height: 100%;
 69 |   background-color: rgba(0, 0, 0, 0.3);
 70 |   display: none;
 71 |   justify-content: center;
 72 |   align-items: center;
 73 | }
 74 | 
 75 | .avatar-image .image-wrapper:hover .overlay {
 76 |   display: flex;
 77 | }
 78 | 
 79 | .avatar-image .image-wrapper .overlay .edit-text {
 80 |   color: white;
 81 |   font-weight: bold;
 82 |   font-size: 1.2rem;
 83 | }
 84 | 
 85 | /* ProfileExplorer cards */
 86 | 
 87 | .card-image {
 88 |   position: relative;
 89 |   height: 300px;
 90 |   overflow: hidden;
 91 | }
 92 | 
 93 | .card-image img {
 94 |   width: 100%;
 95 |   object-fit: cover;
 96 | }
 97 | 
 98 | .card-height {
 99 |   min-height: 100%;
100 | }
101 | 
102 | /* Landing page */
103 | 
104 | header.masthead {
105 |   position: relative;
106 |   background-color: #343a40;
107 |   background: url("../assets/dallas_skyline.jpg") no-repeat center center;
108 |   background-size: cover;
109 |   padding-top: 8rem;
110 |   padding-bottom: 8rem;
111 | }
112 | header.masthead:before {
113 |   content: "";
114 |   position: absolute;
115 |   background-color: #1c375e;
116 |   height: 100%;
117 |   width: 100%;
118 |   top: 0;
119 |   left: 0;
120 |   opacity: 0.5;
121 | }
122 | header.masthead h1,
123 | header.masthead .h1 {
124 |   font-size: 2rem;
125 | }
126 | 
127 | .features-icons {
128 |   padding-top: 7rem;
129 |   padding-bottom: 7rem;
130 | }
131 | .features-icons .features-icons-item {
132 |   max-width: 20rem;
133 | }
134 | .features-icons .features-icons-item .features-icons-icon {
135 |   height: 7rem;
136 | }
137 | .features-icons .features-icons-item .features-icons-icon i {
138 |   font-size: 4.5rem;
139 | }
140 | 
141 | .showcase .showcase-text {
142 |   padding: 3rem;
143 | }
144 | .showcase .showcase-img1 {
145 |   min-height: 30rem;
146 |   background-size: cover;
147 |   background-position: 45% 10%;
148 |   background-image: url("../assets/roommates.jpg");
149 | }
150 | .showcase .showcase-img2 {
151 |   min-height: 30rem;
152 |   background-size: cover;
153 |   background-position: 75% 10%;
154 |   background-image: url("../assets/map.jpg");
155 | }
156 | .showcase .showcase-img3 {
157 |   min-height: 30rem;
158 |   background-size: cover;
159 |   background-position: 55% 75%;
160 |   background-image: url("../assets/moving_out.jpg");
161 | }
162 | 
163 | /* Responsive Changes */
164 | 
165 | @media (min-width: 576px) {
166 | }
167 | 
168 | @media (min-width: 768px) {
169 |   .avatar-image {
170 |     width: 16rem;
171 |     height: 16rem;
172 |   }
173 |   header.masthead {
174 |     padding-top: 12rem;
175 |     padding-bottom: 12rem;
176 |   }
177 |   header.masthead h1,
178 |   header.masthead .h1 {
179 |     font-size: 3rem;
180 |   }
181 |   .showcase .showcase-text {
182 |     padding: 7rem;
183 |   }
184 |   #navbar-dropdown {
185 |     min-width: 90px;
186 |   }
187 | }
188 | 
189 | @media (min-width: 992px) {
190 | }
191 | 
192 | @media (min-width: 1200px) {
193 | }
194 | 
195 | @media (min-width: 1400px) {
196 | }
197 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Profile/RoommateList.jsx:
--------------------------------------------------------------------------------
  1 | import { useState, useEffect } from "react";
  2 | import { Link, useNavigate, useLocation } from "react-router-dom";
  3 | import { useAuth, useAxiosPrivate } from "../../../hooks";
  4 | 
  5 | export const RoommateList = ({ username = false, standalone = false }) => {
  6 |   const { auth } = useAuth();
  7 |   const axiosPrivate = useAxiosPrivate();
  8 |   const navigate = useNavigate();
  9 |   const location = useLocation();
 10 | 
 11 |   const [roommates, setRoommates] = useState([]);
 12 | 
 13 |   useEffect(() => {
 14 |     const getRoommates = async () => {
 15 |       try {
 16 |         const response = await axiosPrivate.get(
 17 |           `/roommate?email=${username ? username : auth.username}`
 18 |         );
 19 |         setRoommates(response.data);
 20 |       } catch (err) {
 21 |         console.error(err);
 22 |         navigate("/login", { state: { from: location }, replace: true });
 23 |       }
 24 |     };
 25 |     getRoommates();
 26 |   }, []);
 27 | 
 28 |   return (
 29 |     <>
 30 |       <div className={standalone ? "container pt-4 pb-5 mb-4" : "pb-2"}>
 31 |         <div
 32 |           className={
 33 |             standalone ? "bg-light rounded p-3 p-md-5 pb-md-4 mb-4" : ""
 34 |           }
 35 |         >
 36 |           <h1 className={standalone ? "fs-1 mb-4" : "fs-3"}>
 37 |             Roommates&nbsp;
 38 |             <span className="text-secondary">
 39 |               (
 40 |               {roommates.length === 0 ? roommates.length : roommates.length - 1}
 41 |               )
 42 |             </span>
 43 |           </h1>
 44 |           {roommates.length === 0 ? (
 45 |             <p
 46 |               className={
 47 |                 standalone
 48 |                   ? "card mt-4 p-3 border-opacity-50"
 49 |                   : "bg-light rounded p-3"
 50 |               }
 51 |             >
 52 |               {username
 53 |                 ? "This user currently has no roommates!"
 54 |                 : "Send a request to become roommates!"}
 55 |             </p>
 56 |           ) : (
 57 |             <ul className="list-group">
 58 |               {roommates &&
 59 |                 roommates
 60 |                   .filter(
 61 |                     (roommate) =>
 62 |                       roommate.email !== (username ? username : auth.username)
 63 |                   )
 64 |                   .map((roommate, index) => (
 65 |                     <div key={index} className="card mb-3">
 66 |                       <div className="card-header fs-4">
 67 |                         <img
 68 |                           src={
 69 |                             roommate.signedUrl
 70 |                               ? roommate.signedUrl
 71 |                               : "/images/default.jpg"
 72 |                           }
 73 |                           alt="Avatar"
 74 |                           className="rounded-circle me-2"
 75 |                           style={{ width: "32px", height: "32px" }}
 76 |                         />
 77 |                         {roommate.name}&nbsp;
 78 |                         <span className="fs-5 d-none d-sm-inline">
 79 |                           {roommate.gender === "male"
 80 |                             ? "(He/Him)"
 81 |                             : "(She/Her)"}
 82 |                         </span>
 83 |                         <Link
 84 |                           to={
 85 |                             roommate.email === auth.username
 86 |                               ? `/profile`
 87 |                               : `/${roommate.email}/profile`
 88 |                           }
 89 |                           className="btn btn-primary btn-sm float-end"
 90 |                         >
 91 |                           View Profile
 92 |                         </Link>
 93 |                       </div>
 94 |                       <div className="card-body">
 95 |                         <p className="card-text text-secondary float-end">
 96 |                           {roommate.city} - {roommate.age}
 97 |                         </p>
 98 |                         <p className="card-text col-10">
 99 |                           <span className="fw-bold">About:&nbsp;</span>
100 |                           {roommate.bio}
101 |                         </p>
102 |                       </div>
103 |                     </div>
104 |                   ))}
105 |             </ul>
106 |           )}
107 |         </div>
108 |       </div>
109 |     </>
110 |   );
111 | };
112 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Routing/LandingPage.jsx:
--------------------------------------------------------------------------------
  1 | import { Link } from "react-router-dom";
  2 | import { PlainNavBar } from "../../common";
  3 | 
  4 | export const LandingPage = () => {
  5 |   return (
  6 |     <>
  7 |       <PlainNavBar />
  8 |       <header className="masthead">
  9 |         <div className="container position-relative">
 10 |           <div className="row justify-content-center">
 11 |             <div className="col-xl-6">
 12 |               <div className="text-center text-white">
 13 |                 <h1 className="mb-5">Find your new roommates today!</h1>
 14 |                 <div className="col-auto">
 15 |                   <Link
 16 |                     to={`register`}
 17 |                     className="btn btn-success btn-lg"
 18 |                     id="submitButton"
 19 |                     type="submit"
 20 |                     data-testid="create-account-button"
 21 |                   >
 22 |                     Create your Account
 23 |                   </Link>
 24 |                 </div>
 25 |               </div>
 26 |             </div>
 27 |           </div>
 28 |         </div>
 29 |       </header>
 30 |       <section className="features-icons bg-light text-center">
 31 |         <div className="container">
 32 |           <div className="row">
 33 |             <div className="col-lg-4">
 34 |               <div className="features-icons-item mx-auto mb-5 mb-lg-0 mb-lg-3">
 35 |                 <div className="features-icons-icon d-flex">
 36 |                   <i className="bi-person-vcard m-auto text-primary"></i>
 37 |                 </div>
 38 |                 <h3 className="fw-bold">Create your Profile</h3>
 39 |                 <p className="lead mb-0">
 40 |                   Describe yourself and what you're looking for in a roommate.
 41 |                 </p>
 42 |               </div>
 43 |             </div>
 44 |             <div className="col-lg-4">
 45 |               <div className="features-icons-item mx-auto mb-5 mb-lg-0 mb-lg-3">
 46 |                 <div className="features-icons-icon d-flex">
 47 |                   <i className="bi-people-fill m-auto text-primary"></i>
 48 |                 </div>
 49 |                 <h3 className="fw-bold">Explore Potential Roommates</h3>
 50 |                 <p className="lead mb-0">
 51 |                   Find people that match your lifestyle and needs.
 52 |                 </p>
 53 |               </div>
 54 |             </div>
 55 |             <div className="col-lg-4">
 56 |               <div className="features-icons-item mx-auto mb-0 mb-lg-3">
 57 |                 <div className="features-icons-icon d-flex">
 58 |                   <i className="bi-person-plus-fill m-auto text-primary"></i>
 59 |                 </div>
 60 |                 <h3 className="fw-bold">Send Roommate Requests</h3>
 61 |                 <p className="lead mb-0">
 62 |                   Reach out to people that you're interested in living with.
 63 |                 </p>
 64 |               </div>
 65 |             </div>
 66 |           </div>
 67 |         </div>
 68 |       </section>
 69 |       <section className="showcase mb-5">
 70 |         <div className="container-fluid p-0">
 71 |           <div className="row g-0">
 72 |             <div className="col-lg-6 order-lg-2 text-white showcase-img1"></div>
 73 |             <div className="col-lg-6 order-lg-1 my-auto showcase-text">
 74 |               <h2 className="fw-bold">Looking for Roommates?</h2>
 75 |               <p className="lead mb-0">
 76 |                 Mate Match allows you to connect with people your age and gender
 77 |                 that have similar personalities and lifestyles.
 78 |               </p>
 79 |             </div>
 80 |           </div>
 81 |           <div className="row g-0">
 82 |             <div className="col-lg-6 text-white showcase-img2"></div>
 83 |             <div className="col-lg-6 my-auto showcase-text">
 84 |               <h2 className="fw-bold">Discover People with Ease</h2>
 85 |               <p className="lead mb-0">
 86 |                 Search for users who need roommates and are located in your
 87 |                 area.
 88 |               </p>
 89 |             </div>
 90 |           </div>
 91 |           <div className="row g-0">
 92 |             <div className="col-lg-6 order-lg-2 text-white showcase-img3"></div>
 93 |             <div className="col-lg-6 order-lg-1 my-auto showcase-text">
 94 |               <h2 className="fw-bold">Perfect for Adulting</h2>
 95 |               <p className="lead mb-0">
 96 |                 Mate Match is the ideal app for college students or anyone
 97 |                 leaving the nest.
 98 |               </p>
 99 |             </div>
100 |           </div>
101 |         </div>
102 |       </section>
103 |     </>
104 |   );
105 | };
106 | 


--------------------------------------------------------------------------------
/backend/models/user.js:
--------------------------------------------------------------------------------
  1 | const knex = require("../config/knex");
  2 | const bcrypt = require("bcrypt");
  3 | const USERS_TABLE = "users";
  4 | const PREF_TABLE = "preferences";
  5 | 
  6 | const fetchAllUsers = async () => {
  7 |   const query = knex(USERS_TABLE).crossJoin(
  8 |     PREF_TABLE,
  9 |     "users.email",
 10 |     "preferences.email"
 11 |   );
 12 |   const results = await query;
 13 |   return results;
 14 | };
 15 | 
 16 | const fetchUserByName = async (name) => {
 17 |   const query = knex(USERS_TABLE)
 18 |     .where({ name })
 19 |     .crossJoin(PREF_TABLE, "users.email", "preferences.email")
 20 |     .where({ "users.email": email });
 21 |   const results = await query;
 22 |   return results;
 23 | };
 24 | 
 25 | const findUserByEmail = async (email) => {
 26 |   const query = knex(USERS_TABLE)
 27 |     .crossJoin(PREF_TABLE, "users.email", "preferences.email")
 28 |     .where({ "users.email": email });
 29 |   const result = await query;
 30 |   return result;
 31 | };
 32 | 
 33 | const updateUser = async (
 34 |   email,
 35 |   photoID,
 36 |   name,
 37 |   age,
 38 |   city,
 39 |   bio,
 40 |   gender,
 41 |   desired_roommates,
 42 |   hasResidence
 43 | ) => {
 44 |   const query = knex(USERS_TABLE)
 45 |     .update({
 46 |       photoID,
 47 |       name,
 48 |       age,
 49 |       city,
 50 |       bio,
 51 |       gender,
 52 |       desired_roommates,
 53 |       hasResidence,
 54 |     })
 55 |     .where({ email });
 56 |   const results = await query;
 57 |   return results;
 58 | };
 59 | 
 60 | const addPref = async (
 61 |   email,
 62 |   apartment,
 63 |   house,
 64 |   condo,
 65 |   nightPerson,
 66 |   morningPerson,
 67 |   extrovert,
 68 |   introvert,
 69 |   smoker,
 70 |   bringFriendsOver,
 71 |   loud,
 72 |   shareFood,
 73 |   messy,
 74 |   pets,
 75 |   relationship
 76 | ) => {
 77 |   const query = knex(PREF_TABLE).insert({
 78 |     email,
 79 |     apartment,
 80 |     house,
 81 |     condo,
 82 |     nightPerson,
 83 |     morningPerson,
 84 |     extrovert,
 85 |     introvert,
 86 |     smoker,
 87 |     bringFriendsOver,
 88 |     loud,
 89 |     shareFood,
 90 |     messy,
 91 |     pets,
 92 |     relationship,
 93 |   });
 94 |   const results = await query;
 95 |   return results;
 96 | };
 97 | 
 98 | const updatePref = async (
 99 |   email,
100 |   apartment,
101 |   house,
102 |   condo,
103 |   nightPerson,
104 |   morningPerson,
105 |   extrovert,
106 |   introvert,
107 |   smoker,
108 |   bringFriendsOver,
109 |   loud,
110 |   shareFood,
111 |   messy,
112 |   pets,
113 |   relationship
114 | ) => {
115 |   const query = knex(PREF_TABLE)
116 |     .update({
117 |       apartment,
118 |       house,
119 |       condo,
120 |       nightPerson,
121 |       morningPerson,
122 |       extrovert,
123 |       introvert,
124 |       smoker,
125 |       bringFriendsOver,
126 |       loud,
127 |       shareFood,
128 |       messy,
129 |       pets,
130 |       relationship,
131 |     })
132 |     .where({ email });
133 |   const results = await query;
134 |   return results;
135 | };
136 | 
137 | const createUser = async (email, password) => {
138 |   const salt = await bcrypt.genSalt(10);
139 |   const hashedPassword = await bcrypt.hash(password, salt);
140 |   const query = knex(USERS_TABLE).insert({ email, password: hashedPassword });
141 |   const result = await query;
142 |   return result;
143 | };
144 | 
145 | const createRefreshToken = async (email, refreshToken) => {
146 |   const query = knex(USERS_TABLE).update({ refreshToken }).where({ email });
147 |   const result = await query;
148 |   return result;
149 | };
150 | 
151 | const findUserByRT = async (refreshToken) => {
152 |   const query = knex(USERS_TABLE).where({ refreshToken });
153 |   const result = await query;
154 |   return result;
155 | };
156 | 
157 | const deleteUser = async (email) => {
158 |   const query = knex(USERS_TABLE).delete().where({ email });
159 |   const results = await query;
160 |   return results;
161 | };
162 | 
163 | const deletePref = async (email) => {
164 |   const query = knex(PREF_TABLE).delete().where({ email });
165 |   const results = await query;
166 |   return results;
167 | };
168 | 
169 | const authenticateUser = async (email, password) => {
170 |   const users = await findUserByEmail(email);
171 |   if (users.length === 0) {
172 |     console.error(`No users matched the email: ${email}`);
173 |     return null;
174 |   }
175 |   const user = users[0];
176 |   const validPassword = await bcrypt.compare(password, user.password);
177 |   if (validPassword) {
178 |     delete user.password;
179 |     return user;
180 |   }
181 |   return null;
182 | };
183 | 
184 | const findPrefByEmail = async (email) => {
185 |   const query = knex(PREF_TABLE).where({ email });
186 |   const result = await query;
187 |   return result;
188 | };
189 | 
190 | module.exports = {
191 |   fetchAllUsers,
192 |   fetchUserByName,
193 |   findUserByEmail,
194 |   updateUser,
195 |   addPref,
196 |   updatePref,
197 |   createUser,
198 |   createRefreshToken,
199 |   findUserByRT,
200 |   deleteUser,
201 |   deletePref,
202 |   authenticateUser,
203 |   findPrefByEmail,
204 | };
205 | 


--------------------------------------------------------------------------------
/backend/models/roommate.js:
--------------------------------------------------------------------------------
  1 | const knex = require("../config/knex");
  2 | const USERS_TABLE = "users";
  3 | const HOUSE_TABLE = "house";
  4 | 
  5 | const addRoommate = async (person1, person2) => {
  6 |   //check if user 1 is already in a house
  7 |   let user1 = await knex.raw(
  8 |     `select * from house where "${person1}" in (email1,email2,email3,email4,email5,email6,email7,email8,email9,email10)`
  9 |   );
 10 |   //check if user 2 is already in a house
 11 |   let user2 = await knex.raw(
 12 |     `select * from house where "${person2}" in (email1,email2,email3,email4,email5,email6,email7,email8,email9,email10)`
 13 |   );
 14 |   //test case 1: if both users are already in a house
 15 |   if (user1[0].length && user2[0].length) {
 16 |     return "Unable, both have a house";
 17 |   }
 18 |   //test case 2: if user1 is in a house and user2 is NOT in a house
 19 |   if (user1[0].length) {
 20 |     house = user1[0][0];
 21 |     //test case 5: if house is full of roommates
 22 |     if (house.email10) return "Unable, house is full";
 23 |     //add user2 to house
 24 |     if (!house.email2)
 25 |       await knex.raw(
 26 |         `update house set email2 = "${person2}" where id=${house.id}`
 27 |       );
 28 |     else if (!house.email3)
 29 |       await knex.raw(
 30 |         `update house set email3 = "${person2}"  where id=${house.id}`
 31 |       );
 32 |     else if (!house.email4)
 33 |       await knex.raw(
 34 |         `update house set email4 = "${person2}" where id=${house.id}`
 35 |       );
 36 |     else if (!house.email5)
 37 |       await knex.raw(
 38 |         `update house set email5 = "${person2}" where id=${house.id}`
 39 |       );
 40 |     else if (!house.email6)
 41 |       await knex.raw(
 42 |         `update house set email6 = "${person2}" where id=${house.id}`
 43 |       );
 44 |     else if (!house.email7)
 45 |       await knex.raw(
 46 |         `update house set email7 = "${person2}" where id=${house.id}`
 47 |       );
 48 |     else if (!house.email8)
 49 |       await knex.raw(
 50 |         `update house set email8 = "${person2}" where id=${house.id}`
 51 |       );
 52 |     else if (!house.email9)
 53 |       await knex.raw(
 54 |         `update house set email9 = "${person2}" where id=${house.id}`
 55 |       );
 56 |     else if (!house.email10)
 57 |       await knex.raw(
 58 |         `update house set email10 = "${person2}" where id=${house.id}`
 59 |       );
 60 | 
 61 |     return "Added to house";
 62 |   }
 63 |   //test case 3: if user2 is in a house and user1 is NOT in a house
 64 |   if (user2[0].length) {
 65 |     house = user2[0][0];
 66 |     //test case 5: if house is full of roommates
 67 |     if (house.email10) return "Unable, house is full";
 68 |     //add user1 to house
 69 |     if (!house.email2)
 70 |       await knex.raw(
 71 |         `update house set email2 = "${person1}" where id=${house.id}`
 72 |       );
 73 |     else if (!house.email3)
 74 |       await knex.raw(
 75 |         `update house set email3 = "${person1}" where id=${house.id}`
 76 |       );
 77 |     else if (!house.email4)
 78 |       await knex.raw(
 79 |         `update house set email4 = "${person1}" where id=${house.id}`
 80 |       );
 81 |     else if (!house.email5)
 82 |       await knex.raw(
 83 |         `update house set email5 = "${person1}" where id=${house.id}`
 84 |       );
 85 |     else if (!house.email6)
 86 |       await knex.raw(
 87 |         `update house set email6 = "${person1}" where id=${house.id}`
 88 |       );
 89 |     else if (!house.email7)
 90 |       await knex.raw(
 91 |         `update house set email7 = "${person1}" where id=${house.id}`
 92 |       );
 93 |     else if (!house.email8)
 94 |       await knex.raw(
 95 |         `update house set email8 = "${person1}" where id=${house.id}`
 96 |       );
 97 |     else if (!house.email9)
 98 |       await knex.raw(
 99 |         `update house set email9 = "${person1}" where id=${house.id}`
100 |       );
101 |     else if (!house.email10)
102 |       await knex.raw(
103 |         `update house set email10 = "${person1}" where id=${house.id}`
104 |       );
105 | 
106 |     return "Added to house";
107 |   }
108 |   //test case 4: if user1 and user2 are NOT in a house
109 |   await knex.raw(
110 |     `insert into house (email1,email2) values ("${person1}","${person2}")`
111 |   );
112 |   return "Created house";
113 | };
114 | 
115 | const getRoommates = async (email) => {
116 |   const house = await knex.raw(
117 |     `select * from house where "${email}" in (email1,email2,email3,email4,email5,email6,email7,email8,email9,email10)`
118 |   );
119 | 
120 |   if (house[0].length === 0) {
121 |     return [];
122 |   }
123 | 
124 |   const result = await knex(USERS_TABLE)
125 |     .where({ email: house[0][0].email1 })
126 |     .orWhere({ email: house[0][0].email2 })
127 |     .orWhere({ email: house[0][0].email3 })
128 |     .orWhere({ email: house[0][0].email4 })
129 |     .orWhere({ email: house[0][0].email5 })
130 |     .orWhere({ email: house[0][0].email6 })
131 |     .orWhere({ email: house[0][0].email7 })
132 |     .orWhere({ email: house[0][0].email8 })
133 |     .orWhere({ email: house[0][0].email9 })
134 |     .orWhere({ email: house[0][0].email10 });
135 |   return result;
136 | };
137 | 
138 | module.exports = {
139 |   addRoommate,
140 |   getRoommates,
141 | };
142 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Account/Registration.jsx:
--------------------------------------------------------------------------------
  1 | import { useState, useEffect } from "react";
  2 | import { Link, useNavigate } from "react-router-dom";
  3 | import { registerAccount, handleLogin } from "../../../api";
  4 | import { useAuth } from "../../../hooks";
  5 | import { CredentialsField, PlainNavBar } from "../../common";
  6 | 
  7 | const USER_REGEX = /^[a-zA-Z][a-zA-Z0-9-_]{3,11}$/;
  8 | const PASSWORD_REGEX =
  9 |   /^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.*[!@#$%]).{8,24}$/;
 10 | 
 11 | export const Registration = () => {
 12 |   const { setAuth } = useAuth();
 13 |   const navigate = useNavigate();
 14 | 
 15 |   const [username, setUserName] = useState("");
 16 |   const [validUserName, setValidUserName] = useState(false);
 17 |   const [userNameFocus, setUserNameFocus] = useState(false);
 18 | 
 19 |   const [password, setPassword] = useState("");
 20 |   const [validPassword, setValidPassword] = useState(false);
 21 |   const [passwordFocus, setPasswordFocus] = useState(false);
 22 | 
 23 |   const [confirmPassword, setConfirmPassword] = useState("");
 24 |   const [validConfirm, setValidConfirm] = useState(false);
 25 |   const [confirmFocus, setConfirmFocus] = useState(false);
 26 | 
 27 |   const [errorMessage, setErrorMessage] = useState("");
 28 | 
 29 |   useEffect(() => {
 30 |     setValidUserName(USER_REGEX.test(username));
 31 |   }, [username]);
 32 | 
 33 |   useEffect(() => {
 34 |     setValidPassword(PASSWORD_REGEX.test(password));
 35 |     setValidConfirm(password === confirmPassword);
 36 |   }, [password, confirmPassword]);
 37 | 
 38 |   useEffect(() => {
 39 |     setErrorMessage("");
 40 |   }, [username, password, confirmPassword]);
 41 | 
 42 |   const handleSubmit = async (e) => {
 43 |     e.preventDefault();
 44 | 
 45 |     registerAccount(username, password).then((x) => {
 46 |       if (!x["message"]) {
 47 |         handleLogin(username, password).then((accessToken) => {
 48 |           setAuth({ username, accessToken });
 49 |           setUserName("");
 50 |           setPassword("");
 51 |           setConfirmPassword("");
 52 |           navigate(`/profile/edit`);
 53 |         });
 54 |       } else {
 55 |         setErrorMessage(x["message"]);
 56 |       }
 57 |     });
 58 |   };
 59 | 
 60 |   return (
 61 |     <>
 62 |       <PlainNavBar />
 63 |       <div className="container pt-4 pb-5 mb-4">
 64 |         <div className="bg-light rounded mx-auto col-xl-6 p-3 p-md-5 pb-md-3 mb-4">
 65 |           <div className={errorMessage ? "alert alert-danger" : "d-none"}>
 66 |             {errorMessage}
 67 |           </div>
 68 |           <h1>Register Your Account</h1>
 69 |           <CredentialsField
 70 |             label="Username:"
 71 |             id="username"
 72 |             value={username}
 73 |             setValue={(name) => setUserName(name)}
 74 |             setFocus={(x) => setUserNameFocus(x)}
 75 |           />
 76 |           <div
 77 |             className={
 78 |               userNameFocus && !validUserName ? "alert alert-primary" : "d-none"
 79 |             }
 80 |           >
 81 |             4 to 12 characters.
 82 |             <br />
 83 |             Must begin with a letter.
 84 |             <br />
 85 |             Letters, numbers, underscores, hyphens allowed.
 86 |           </div>
 87 |           <CredentialsField
 88 |             label="Password:"
 89 |             password={true}
 90 |             id="password"
 91 |             value={password}
 92 |             setValue={(pwd) => setPassword(pwd)}
 93 |             setFocus={(x) => setPasswordFocus(x)}
 94 |           />
 95 |           <p
 96 |             className={
 97 |               (passwordFocus || password) && !validPassword
 98 |                 ? "alert alert-primary"
 99 |                 : "d-none"
100 |             }
101 |           >
102 |             8 to 24 characters.
103 |             <br />
104 |             Must include uppercase and lowercase letters, a number, and a
105 |             special character.
106 |             <br />
107 |             Allowed special characters: ! @ # $ %
108 |           </p>
109 |           <CredentialsField
110 |             label="Confirm Password:"
111 |             password={true}
112 |             id="confirmPassword"
113 |             value={confirmPassword}
114 |             setValue={(confirmPwd) => setConfirmPassword(confirmPwd)}
115 |             setFocus={(x) => setConfirmFocus(x)}
116 |           />
117 |           <p
118 |             className={
119 |               (confirmFocus || confirmPassword) && !validConfirm
120 |                 ? "alert alert-primary"
121 |                 : "d-none"
122 |             }
123 |           >
124 |             Must match the first password input field.
125 |           </p>
126 |           <button
127 |             type="button"
128 |             className="btn btn-primary btn-lg col-12 mt-1 mb-2"
129 |             disabled={
130 |               !validUserName || !validPassword || !validConfirm ? true : false
131 |             }
132 |             onClick={handleSubmit}
133 |           >
134 |             Sign Up
135 |           </button>
136 |           <hr />
137 |           <p className="mt-1">
138 |             Already have an account?&nbsp;
139 |             <Link to={`/login`}>Sign in</Link>
140 |           </p>
141 |         </div>
142 |       </div>
143 |     </>
144 |   );
145 | };
146 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Dashboard/ProfileSearch.jsx:
--------------------------------------------------------------------------------
  1 | import { useState, useEffect } from "react";
  2 | import { SearchField, CheckBoxDropdown } from "../../common";
  3 | import { Filter } from "../../../models";
  4 | 
  5 | export const ProfileSearch = ({ profiles, setSearchResults }) => {
  6 |   const lifestyleFilters = [
  7 |     new Filter("nightPerson", "Night-owl", false),
  8 |     new Filter("morningPerson", "Early-bird", false),
  9 |     new Filter("pets", "Pet-Friendly", false),
 10 |     new Filter("shareFood", "Shares Food", false),
 11 |   ];
 12 | 
 13 |   const propertyFilters = [
 14 |     new Filter("apartment", "Apartment", false),
 15 |     new Filter("house", "House", false),
 16 |     new Filter("condo", "Condo", false),
 17 |     new Filter("hasResidence", "Has Housing", false),
 18 |   ];
 19 | 
 20 |   const ageFilters = [
 21 |     new Filter("18-23", "18-23", false),
 22 |     new Filter("24-29", "24-29", false),
 23 |     new Filter("30+", "30+", false),
 24 |   ];
 25 | 
 26 |   const genderFilters = [
 27 |     new Filter("male", "Man", false),
 28 |     new Filter("female", "Woman", false),
 29 |   ];
 30 | 
 31 |   const [lifestylePref, setLifestylePref] = useState(lifestyleFilters);
 32 |   const [propertyPref, setPropertyPref] = useState(propertyFilters);
 33 |   const [agePref, setAgePref] = useState(ageFilters);
 34 |   const [genderPref, setGenderPref] = useState(genderFilters);
 35 |   const [search, setSearch] = useState("");
 36 | 
 37 |   useEffect(() => {
 38 |     let results = profiles;
 39 |     //update with search
 40 |     if (search !== "") {
 41 |       results = results.filter(
 42 |         (profile) =>
 43 |           profile.name.toLowerCase().indexOf(search.toLowerCase()) >= 0 ||
 44 |           profile.city.toLowerCase().indexOf(search.toLowerCase()) >= 0
 45 |       );
 46 |     }
 47 |     //update with lifestyle filter
 48 |     const lifeFilters = lifestylePref.filter((pref) => pref.value);
 49 |     if (lifeFilters.length !== 0) {
 50 |       results = results.filter((profile) => {
 51 |         let filterCheck = true;
 52 |         lifeFilters.forEach((pref) => {
 53 |           if (!profile[pref.id]) {
 54 |             filterCheck = false;
 55 |           }
 56 |         });
 57 |         return filterCheck;
 58 |       });
 59 |     }
 60 |     //update with property filter
 61 |     const propFilters = propertyPref.filter((pref) => pref.value);
 62 |     if (propFilters.length !== 0) {
 63 |       results = results.filter((profile) => {
 64 |         let filterCheck = true;
 65 |         propFilters.forEach((pref) => {
 66 |           if (!profile[pref.id]) {
 67 |             filterCheck = false;
 68 |           }
 69 |         });
 70 |         return filterCheck;
 71 |       });
 72 |     }
 73 |     //update with age filter
 74 |     const yearFilters = agePref.filter((pref) => pref.value);
 75 |     if (yearFilters.length !== 0 && yearFilters.length !== 3) {
 76 |       results = results.filter((profile) => {
 77 |         let filterCheck = false;
 78 |         yearFilters.forEach((pref) => {
 79 |           if (pref.id === "18-23") {
 80 |             if (18 <= profile.age && profile.age <= 23) filterCheck = true;
 81 |           } else if (pref.id === "24-29") {
 82 |             if (24 <= profile.age && profile.age <= 29) filterCheck = true;
 83 |           } else if (pref.id === "30+") {
 84 |             if (30 <= profile.age) filterCheck = true;
 85 |           }
 86 |         });
 87 |         return filterCheck;
 88 |       });
 89 |     }
 90 |     //update with gender filter
 91 |     const genFilters = genderPref.filter((pref) => pref.value);
 92 |     if (genFilters.length !== 0 && genFilters.length !== 2) {
 93 |       results = results.filter((profile) => {
 94 |         let filterCheck = true;
 95 |         genFilters.forEach((pref) => {
 96 |           if (profile.gender !== pref.id) {
 97 |             filterCheck = false;
 98 |           }
 99 |         });
100 |         return filterCheck;
101 |       });
102 |     }
103 |     setSearchResults(results);
104 |   }, [lifestylePref, propertyPref, agePref, genderPref, search]);
105 | 
106 |   return (
107 |     <>
108 |       <h1>Profile Explorer</h1>
109 |       <div className="row justify-content-start">
110 |         <div className="col-xs-12 col-md-6 col-lg-4">
111 |           <SearchField value={search} setValue={(s) => setSearch(s)} />
112 |         </div>
113 |         <div className="col-lg-8 d-flex align-content-start flex-wrap ps-lg-0">
114 |           <div className="d-flex align-content-start pb-2 pb-sm-0">
115 |             <div className="pe-3">
116 |               <CheckBoxDropdown
117 |                 dd_label="Lifestyle "
118 |                 options={lifestylePref}
119 |                 setValues={setLifestylePref}
120 |               />
121 |             </div>
122 |             <div className="pe-3">
123 |               <CheckBoxDropdown
124 |                 dd_label="Property "
125 |                 options={propertyPref}
126 |                 setValues={setPropertyPref}
127 |               />
128 |             </div>
129 |           </div>
130 |           <div className="d-flex align-content-start">
131 |             <div className="pe-3">
132 |               <CheckBoxDropdown
133 |                 dd_label="Gender "
134 |                 options={genderPref}
135 |                 setValues={setGenderPref}
136 |               />
137 |             </div>
138 |             <div className="pe-3">
139 |               <CheckBoxDropdown
140 |                 dd_label="Age "
141 |                 options={agePref}
142 |                 setValues={setAgePref}
143 |               />
144 |             </div>
145 |           </div>
146 |         </div>
147 |       </div>
148 |       <hr />
149 |     </>
150 |   );
151 | };
152 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | <img src="https://github.com/kirkwat/mate-match/assets/60279003/54c7fbfa-91e0-40bc-877b-7957075f6481" 
  2 |      alt="Mate Match"
  3 |      width="400rem"/>
  4 | 
  5 | #### This is a full-stack web application that allows users to find new roommates tailored to their preferences. [Click here](https://www.youtube.com/watch?v=c0ZcLqA5QlE) to view the demo.
  6 | 
  7 | <hr/>
  8 | 
  9 | ## Table of Contents
 10 | 
 11 | - [Features](#features)
 12 |   - [Frontend](#frontend)
 13 |   - [Backend](#backend)
 14 | - [Cloud Architecture](#cloud-architecture)
 15 | - [CI/CD](#cicd)
 16 |   - [Unit Testing](#unit-testing)
 17 |   - [Deployment](#deployment)
 18 | - [Configuration](#configuration)
 19 |   - [Development](#development)
 20 |   - [Production](#production)
 21 | - [Next Steps](#next-steps)
 22 | 
 23 | ## Features
 24 | 
 25 | - Create a personal account that provides secure authentication.
 26 | - Create and edit personal profile with an avatar image, description, and personal details such as lifestyle preferences.
 27 | - Search across other users on the platform and filter results based on user traits.
 28 | - View user profiles with ability to send roommate requests with custom messages.
 29 | - View sent and received roommate requests with ability rescind sent requests and approve/decline received requests.
 30 | - View list of personal roommates as well as roommates of other users.
 31 | 
 32 | ### Frontend
 33 | 
 34 | #### Technologies: React.js Client, Axios, Bootstrap
 35 | 
 36 | - Integrated API calls using Axios to communicate with the backend server.
 37 | - Applied theming and styling to the user interface using the Bootstrap framework for a consistent and visually appealing design.
 38 | - Enforced Login Authentication using JWT (JSON Web Tokens) for secure and authenticated user sessions.
 39 | - Implemented the use of Access and Refresh Tokens to manage persistent login sessions and ensure authorized access to protected routes.
 40 | - Developed a user-friendly form for creating and updating user profiles, allowing users to input and save their personal information.
 41 | - Utilized profile search functionality with advanced filter options to help users find desired profiles based on specific criteria.
 42 | - Enabled users to view and interact with other users, including sending and managing roommate requests, approving or declining received requests, and managing existing roommates.
 43 | 
 44 | ### Backend
 45 | 
 46 | #### Technologies: Express Server, Knex.js, AWS SDK
 47 | 
 48 | - Implemented MVC (Model-View-Controller) pattern to provide a structured and organized codebase, separating concerns for better maintainability and scalability.
 49 | - Utilized Knex.js to interact with the database by performing queries and modifications necessary for editing profiles, sending roommate requests, and adding roommates.
 50 | - Applied CORS (Cross-Origin Resource Sharing) to only allow requests from whitelisted origins, ensuring a secure and controlled API access.
 51 | - Established authentication using JWT (JSON Web Tokens) with access tokens and refresh tokens, enabling persistent authentication and secure user sessions.
 52 | - Leveraged the AWS SDK to add and delete images from the S3 bucket, providing efficient management of avatar images.
 53 | - Used the AWS SDK to generate signed URLs with CloudFront and a private key retrieved from Secrets Manager, ensuring secure access to avatar images.
 54 | - Configured logging midddleware to record API requests and errors, facilitating debugging and monitoring of the application.
 55 | - Utilized Knex database schema migrations to manage and version the database schema, allowing seamless updates and deployments.
 56 | 
 57 | ## Cloud Architecture
 58 | 
 59 | ![High Level Cloud Architecture Diagram](https://github.com/kirkwat/mate-match/assets/60279003/024714eb-f4df-4145-b9b5-b2e504253ad9)
 60 | 
 61 | 
 62 | The application was deployed on the AWS Cloud, following an architecture that adheres to the AWS Well-Architected Framework. Various AWS services were utilized to ensure alignment with recommended cloud architecture practices.
 63 | 
 64 | The front-end React app client was deployed using a combination of AWS services, including CloudFront for content delivery, Amazon S3 for storage, ACM (AWS Certificate Manager) for SSL certificates, and Route 53 for DNS management.
 65 | 
 66 | The back-end Node.js Express API was containerized using ECS (Elastic Container Service) and stored in ECR (Elastic Container Registry). It was deployed using Fargate, a serverless compute engine for containers, and integrated with an ALB (Application Load Balancer) for traffic distribution.
 67 | 
 68 | For the database, RDS (Relational Database Service) was utilized with MySQL to store application data.
 69 | 
 70 | Avatar images were stored and served using CloudFront and S3, providing scalable and high-performance image delivery.
 71 | 
 72 | To securely retrieve private keys for generating CloudFront signed URLs, the Express API utilized Secrets Manager to securely retrieve and manage sensitive information.
 73 | 
 74 | ## CI/CD
 75 | 
 76 | ### Unit Testing
 77 | 
 78 | The development process followed test-driven methodology, where emphasis was placed on writing unit tests for both backend Express API calls and frontend React elements. Unit tests were required to pass successfully as part of the quality assurance process before merging any pull requests into the main branch. This approach ensured the reliability and stability of the codebase by verifying the functionality of individual components and their interactions.
 79 | 
 80 | ### Deployment
 81 | 
 82 | GitHub Actions is utilized to automate the deployment process for changes pushed to the main branch. The deployment workflow involves compiling the React client and sending the bundle to an S3 bucket. Subsequently, the CloudFront cache is invalidated to ensure the delivery of the updated content. For the Express API, a new version of the Docker image is uploaded to the ECR (Elastic Container Registry), which is then used within the ECS cluster to deploy the latest changes. This streamlined approach ensures efficient and consistent deployment of the application.
 83 | 
 84 | ## Configuration
 85 | 
 86 | ### Development
 87 | 
 88 | - Frontend:
 89 |   - Configure the `.env` file in the frontend directory by setting the `REACT_APP_API_URL` variable to http://localhost:8000 in order to establish a connection with the Express API.
 90 |   - Install dependencies and run the command `npm run start` to launch the React app in developer mode, enabling real-time code changes and automatic reloading.
 91 | - Backend:
 92 |   - Configure the `.env` file in the backend directory by setting the `CLIENT_URL` variable to http://localhost:3000 in order to establish a connection with the React client.
 93 |   - Ensure that the `ACCESS_TOKEN_SECRET` and `REFRESH_TOKEN_SECRET` environment variables are properly set for user authentication.
 94 |   - Set up a local MySQL database using Docker or deploy an RDS instance on AWS. Configure the necessary MySQL environment variables to establish a connection with the database.
 95 |   - To use the avatar image feature, set up and configure the required AWS services: S3, CloudFront, and Secrets Manager. Utilize Secrets Manager to securely store the private key required to generate signed CloudFront URLs for avatar images.
 96 |   - Install dependencies and run the command `npm run dev` to launch the Express server in developer mode, enabling real-time code changes and automatic reloading.
 97 | 
 98 | ### Production
 99 | 
100 | - Frontend:
101 |   - Configure the `.env` file in the frontend directory by setting the `REACT_APP_API_URL` variable to https://api.matematching.com in order to establish a connection with the Express API.
102 |   - Configure a S3 bucket to store the static content of the React app, CloudFront as the CDN to distribute the content globally, Route 53 for DNS management, and ACM to handle SSL/TLS certificates for secure communication.
103 |   - Install dependencies and run the command `npm run deploy` to compile the React app, upload content to S3 bucket, and invalidate the CloudFront cache.
104 | - Backend:
105 |   - Configure the `.env` file in the backend directory by setting the `CLIENT_URL` variable to https://matematching.com in order to establish a connection with the React client.
106 |   - Ensure that the `ACCESS_TOKEN_SECRET` and `REFRESH_TOKEN_SECRET` environment variables are properly set for user authentication.
107 |   - Deploy an MySQL RDS instance on AWS and configure the necessary MySQL environment variables to establish a connection with the database.
108 |   - Configure ECR to store the Docker image of the backend Node.js Express server, ECS to manage the containerized deployment, Fargate for serverless compute capacity, and ALB to distribute incoming traffic.
109 |   - To use the avatar image feature, set up and configure the required AWS services: S3, CloudFront, and Secrets Manager. Utilize Secrets Manager to securely store the private key required to generate signed CloudFront URLs for avatar images.
110 | 
111 | ## Next Steps
112 | 
113 | If I were to continue working on this project, this is where I would start next.
114 | 
115 | - Develop a CloudFormation or Terraform configuration file to streamline the setup of the cloud architecture, enabling simple replication and deployment.
116 | - Implement an instant messaging feature within the application, empowering users to engage in real-time conversations before initiating roommate requests, fostering better communication and connection.
117 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Profile/RequestList.jsx:
--------------------------------------------------------------------------------
  1 | import { useState, useEffect } from "react";
  2 | import { Link, useNavigate, useLocation } from "react-router-dom";
  3 | import { useAuth, useAxiosPrivate } from "../../../hooks";
  4 | 
  5 | export const RequestList = () => {
  6 |   const { auth } = useAuth();
  7 |   const axiosPrivate = useAxiosPrivate();
  8 |   const navigate = useNavigate();
  9 |   const location = useLocation();
 10 | 
 11 |   const [receivedRequests, setReceivedRequests] = useState([]);
 12 |   const [sentRequests, setSentRequests] = useState([]);
 13 |   const [toOrFrom, setToOrFrom] = useState(false);
 14 |   const [sender, setSender] = useState(undefined);
 15 |   const [recipient, setRecipient] = useState(undefined);
 16 | 
 17 |   useEffect(() => {
 18 |     const getRequestsForRecipient = async () => {
 19 |       try {
 20 |         const response = await axiosPrivate.get(
 21 |           `/request/?to=${auth.username}`
 22 |         );
 23 |         setReceivedRequests(response.data);
 24 |       } catch (err) {
 25 |         console.error(err);
 26 |         navigate("/login", { state: { from: location }, replace: true });
 27 |       }
 28 |     };
 29 |     const getRequestsForSender = async () => {
 30 |       try {
 31 |         const response = await axiosPrivate.get(
 32 |           `/request/?from=${auth.username}`
 33 |         );
 34 |         setSentRequests(response.data);
 35 |       } catch (err) {
 36 |         console.error(err);
 37 |         navigate("/login", { state: { from: location }, replace: true });
 38 |       }
 39 |     };
 40 |     getRequestsForRecipient();
 41 |     getRequestsForSender();
 42 |   }, []);
 43 | 
 44 |   const deleteRequest = async (to, from) => {
 45 |     try {
 46 |       await axiosPrivate.delete(`/request/?to=${to}&from=${from}`);
 47 |     } catch (err) {
 48 |       console.error(err);
 49 |       navigate("/login", { state: { from: location }, replace: true });
 50 |     }
 51 |   };
 52 | 
 53 |   useEffect(() => {
 54 |     const addRoommate = async () => {
 55 |       try {
 56 |         const response = await axiosPrivate.post(`/roommate`, {
 57 |           person1: sender.sender,
 58 |           person2: auth.username,
 59 |         });
 60 |         return response.data;
 61 |       } catch (err) {
 62 |         console.error(err);
 63 |         navigate("/login", { state: { from: location }, replace: true });
 64 |       }
 65 |     };
 66 | 
 67 |     if (sender) {
 68 |       if (sender.status === 0) {
 69 |         deleteRequest(auth.username, sender.sender).then(
 70 |           setReceivedRequests(
 71 |             receivedRequests.filter((x) => x.from !== sender.sender)
 72 |           )
 73 |         );
 74 |       } else if (sender.status === 1) {
 75 |         deleteRequest(auth.username, sender.sender).then(
 76 |           setReceivedRequests(
 77 |             receivedRequests.filter((x) => x.from !== sender.sender)
 78 |           )
 79 |         );
 80 |         addRoommate();
 81 |       }
 82 |     }
 83 |   }, [sender]);
 84 | 
 85 |   useEffect(() => {
 86 |     if (recipient) {
 87 |       deleteRequest(recipient, auth.username).then(
 88 |         setSentRequests(sentRequests.filter((x) => x.to !== recipient))
 89 |       );
 90 |     }
 91 |   }, [recipient]);
 92 | 
 93 |   return (
 94 |     <>
 95 |       <div className="container pt-4 pb-5 mb-4">
 96 |         <div className="bg-light rounded p-3 p-md-5 pb-md-4 mb-4">
 97 |           <h1>Roommate Requests</h1>
 98 |           <ul className="nav nav-tabs mb-3">
 99 |             <li className="nav-item">
100 |               <button
101 |                 className={
102 |                   toOrFrom
103 |                     ? "nav-link text-secondary"
104 |                     : "nav-link active text-black"
105 |                 }
106 |                 onClick={() => {
107 |                   setToOrFrom(false);
108 |                 }}
109 |               >
110 |                 Received&nbsp;
111 |                 <span>({receivedRequests.length})</span>
112 |               </button>
113 |             </li>
114 |             <li className="nav-item">
115 |               <button
116 |                 className={
117 |                   toOrFrom
118 |                     ? "nav-link active text-black"
119 |                     : "nav-link text-secondary"
120 |                 }
121 |                 onClick={() => {
122 |                   setToOrFrom(true);
123 |                 }}
124 |               >
125 |                 Sent&nbsp;
126 |                 <span>({sentRequests.length})</span>
127 |               </button>
128 |             </li>
129 |           </ul>
130 |           {!toOrFrom ? (
131 |             receivedRequests.length === 0 ? (
132 |               <p className="card mt-4 p-3 border-opacity-50">
133 |                 Your roommate requests from other users will appear here.
134 |               </p>
135 |             ) : (
136 |               <ul className="list-group mt-4">
137 |                 {receivedRequests &&
138 |                   receivedRequests.map((request, index) => (
139 |                     <div key={index} className="card mb-3">
140 |                       <div className="card-header fs-4">
141 |                         <img
142 |                           src={
143 |                             request.signedUrl
144 |                               ? request.signedUrl
145 |                               : "/images/default.jpg"
146 |                           }
147 |                           alt="Avatar"
148 |                           className="rounded-circle me-2"
149 |                           style={{ width: "32px", height: "32px" }}
150 |                         />
151 |                         {request.name}&nbsp;
152 |                         <span className="fs-5 d-none d-sm-inline">
153 |                           {request.gender === "male" ? "(He/Him)" : "(She/Her)"}
154 |                         </span>
155 |                         <Link
156 |                           to={`/${request.from}/profile`}
157 |                           className="btn btn-primary btn-sm float-end"
158 |                         >
159 |                           View Profile
160 |                         </Link>
161 |                       </div>
162 |                       <div className="card-body">
163 |                         <p className="card-text text-secondary float-end">
164 |                           {request.city} - {request.age}
165 |                         </p>
166 |                         <p className="card-text col-10">
167 |                           <span className="fw-bold">
168 |                             Request Message:&nbsp;
169 |                           </span>
170 |                           {request.message ? request.message : "No message."}
171 |                         </p>
172 |                         <div className="btn-group col-12 col-sm-auto">
173 |                           <button
174 |                             type="button"
175 |                             className="btn btn-danger"
176 |                             onClick={() =>
177 |                               setSender({ sender: request.from, status: 0 })
178 |                             }
179 |                           >
180 |                             Decline
181 |                           </button>
182 |                           <button
183 |                             type="button"
184 |                             className="btn btn-success"
185 |                             onClick={() =>
186 |                               setSender({ sender: request.from, status: 1 })
187 |                             }
188 |                           >
189 |                             Approve
190 |                           </button>
191 |                         </div>
192 |                       </div>
193 |                     </div>
194 |                   ))}
195 |               </ul>
196 |             )
197 |           ) : sentRequests.length === 0 ? (
198 |             <p className="card mt-4 p-3 border-opacity-50">
199 |               Roommate requests that you send to other users will appear here.
200 |             </p>
201 |           ) : (
202 |             <ul className="list-group mt-4">
203 |               {sentRequests &&
204 |                 sentRequests.map((request, index) => (
205 |                   <div key={index} className="card mb-3">
206 |                     <div className="card-header fs-4">
207 |                       <img
208 |                         src={
209 |                           request.signedUrl
210 |                             ? request.signedUrl
211 |                             : "/images/default.jpg"
212 |                         }
213 |                         alt="Avatar"
214 |                         className="rounded-circle me-2"
215 |                         style={{ width: "32px", height: "32px" }}
216 |                       />
217 |                       {request.name}&nbsp;
218 |                       <span className="fs-5 d-none d-sm-inline">
219 |                         {request.gender === "male" ? "(He/Him)" : "(She/Her)"}
220 |                       </span>
221 |                       <Link
222 |                         to={`/${request.to}/profile`}
223 |                         className="btn btn-primary btn-sm float-end"
224 |                       >
225 |                         View Profile
226 |                       </Link>
227 |                     </div>
228 |                     <div className="card-body">
229 |                       <p className="card-text text-secondary float-end">
230 |                         {request.city} - {request.age}
231 |                       </p>
232 |                       <p className="card-text col-10">
233 |                         <span className="fw-bold">Request Message:&nbsp;</span>
234 |                         {request.message
235 |                           ? request.message
236 |                           : "No message with this request."}
237 |                       </p>
238 |                       <button
239 |                         type="button"
240 |                         className="btn btn-outline-danger col-12 col-sm-auto"
241 |                         onClick={() => setRecipient(request.to)}
242 |                       >
243 |                         Delete Request
244 |                       </button>
245 |                     </div>
246 |                   </div>
247 |                 ))}
248 |             </ul>
249 |           )}
250 |         </div>
251 |       </div>
252 |     </>
253 |   );
254 | };
255 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Profile/ProfileDetails.jsx:
--------------------------------------------------------------------------------
  1 | import { useState, useEffect } from "react";
  2 | import { Link, useNavigate, useLocation, useParams } from "react-router-dom";
  3 | import { useAuth, useAxiosPrivate } from "../../../hooks";
  4 | import { RoommateList } from "./RoommateList";
  5 | import { TextAreaField } from "../../common";
  6 | 
  7 | export const ProfileDetails = () => {
  8 |   const { auth } = useAuth();
  9 |   const params = useParams();
 10 |   const axiosPrivate = useAxiosPrivate();
 11 |   const navigate = useNavigate();
 12 |   const location = useLocation();
 13 | 
 14 |   const [profile, setProfile] = useState(undefined);
 15 |   const [roommate, setRoommate] = useState(false);
 16 |   const [sentRequest, setSentRequest] = useState(undefined);
 17 |   const [receivedRequest, setReceivedRequest] = useState(undefined);
 18 |   const [message, setMessage] = useState("");
 19 | 
 20 |   useEffect(() => {
 21 |     const getProfile = async () => {
 22 |       try {
 23 |         const response = await axiosPrivate.get(
 24 |           `/user?email=${params.username ? params.username : auth.username}`
 25 |         );
 26 |         setProfile(response.data[0]);
 27 |       } catch (err) {
 28 |         console.error(err);
 29 |         navigate("/login", { state: { from: location }, replace: true });
 30 |       }
 31 |     };
 32 |     const checkRequest = async (to, from) => {
 33 |       try {
 34 |         const response = await axiosPrivate.get(
 35 |           `/request/?to=${to}&from=${from}`
 36 |         );
 37 |         return response.data;
 38 |       } catch (err) {
 39 |         console.error(err);
 40 |         navigate("/login", { state: { from: location }, replace: true });
 41 |       }
 42 |     };
 43 |     const getRoommates = async () => {
 44 |       try {
 45 |         const response = await axiosPrivate.get(
 46 |           `/roommate?email=${auth.username}`
 47 |         );
 48 |         return response.data;
 49 |       } catch (err) {
 50 |         console.error(err);
 51 |         navigate("/login", { state: { from: location }, replace: true });
 52 |       }
 53 |     };
 54 |     getProfile();
 55 |     if (params.username) {
 56 |       getRoommates().then((x) =>
 57 |         setRoommate(
 58 |           x.filter((user) => user.email === params.username).length !== 0
 59 |         )
 60 |       );
 61 |       checkRequest(params.username, auth.username).then((x) =>
 62 |         setSentRequest(x[0])
 63 |       );
 64 |       checkRequest(auth.username, params.username).then((x) =>
 65 |         setReceivedRequest(x[0])
 66 |       );
 67 |     }
 68 |   }, [params]);
 69 | 
 70 |   const handleSendRequest = () => {
 71 |     const sendRequest = async () => {
 72 |       try {
 73 |         const response = await axiosPrivate.post(`/request`, {
 74 |           to: params.username,
 75 |           from: auth.username,
 76 |           message: message,
 77 |         });
 78 |         return response.data;
 79 |       } catch (err) {
 80 |         console.error(err);
 81 |         navigate("/login", { state: { from: location }, replace: true });
 82 |       }
 83 |     };
 84 |     sendRequest();
 85 |     setSentRequest(true);
 86 |   };
 87 | 
 88 |   if (!profile) {
 89 |     return (
 90 |       <>
 91 |         <div className="container pt-4 pb-5 mb-4">
 92 |           <div className="bg-light rounded p-3 p-md-5 pb-md-4 mb-4">
 93 |             <div className="spinner-border" role="status">
 94 |               <span className="visually-hidden">Loading Profile...</span>
 95 |             </div>
 96 |             <span className="fs-2 fw-bold">&nbsp;Loading Profile...</span>
 97 |           </div>
 98 |         </div>
 99 |       </>
100 |     );
101 |   }
102 | 
103 |   return (
104 |     <>
105 |       <div className="container pt-4 pb-5 mb-4">
106 |         <div className="bg-light rounded p-3 p-md-5 pb-md-4 mb-3">
107 |           <div className="avatar-image float-sm-end mb-2">
108 |             <div className="image-wrapper">
109 |               <img
110 |                 src={
111 |                   profile.signedUrl ? profile.signedUrl : "/images/default.jpg"
112 |                 }
113 |                 alt="avatar"
114 |                 className="img-fluid"
115 |               />
116 |             </div>
117 |           </div>
118 |           <h1 className="display-5 text-center text-sm-start">
119 |             <span className="fw-bold">{profile.name}</span>
120 |             <span className="fs-1">
121 |               &nbsp;
122 |               {profile.gender === "male" ? "(He/Him)" : "(She/Her)"}
123 |             </span>
124 |           </h1>
125 |           <h3 className="display-7 text-center text-sm-start">
126 |             <span>{profile.city}</span>
127 |             <span> - {profile.age}</span>
128 |           </h3>
129 |           <p className="fs-5 col-md-8 text-center text-sm-start">
130 |             {profile.bio}
131 |           </p>
132 |           <ul className="list-group list-group-flush">
133 |             <li className="list-group-item bg-light"></li>
134 |             <li className="list-group-item bg-light">
135 |               {profile.hasResidence
136 |                 ? "I currently have housing."
137 |                 : "I currently don't have housing."}
138 |             </li>
139 |             <li className="list-group-item bg-light">
140 |               <span className="fw-bold">Roommates needed:&nbsp;</span>
141 |               {profile.desired_roommates}
142 |             </li>
143 |             <li className="list-group-item bg-light">
144 |               <span className="fw-bold">Property Preferences:&nbsp;</span>
145 |               <span className={profile.apartment ? "" : "d-none"}>
146 |                 Apartment
147 |               </span>
148 |               <span
149 |                 className={
150 |                   profile.apartment && (profile.house || profile.condo)
151 |                     ? ""
152 |                     : "d-none"
153 |                 }
154 |               >
155 |                 ,&nbsp;
156 |               </span>
157 |               <span className={profile.house ? "" : "d-none"}>House</span>
158 |               <span className={profile.house && profile.condo ? "" : "d-none"}>
159 |                 ,&nbsp;
160 |               </span>
161 |               <span className={profile.condo ? "" : "d-none"}>Condo</span>
162 |             </li>
163 |             <li className="list-group-item bg-light">
164 |               <span className="fw-bold">Lifestyle Preferences:&nbsp;</span>
165 |               <span className={profile.nightPerson ? "" : "d-none"}>
166 |                 Night-owl
167 |               </span>
168 |               <span
169 |                 className={
170 |                   profile.nightPerson &&
171 |                   (profile.morningPerson || profile.shareFood || profile.pets)
172 |                     ? ""
173 |                     : "d-none"
174 |                 }
175 |               >
176 |                 ,&nbsp;
177 |               </span>
178 |               <span className={profile.morningPerson ? "" : "d-none"}>
179 |                 Early-bird
180 |               </span>
181 |               <span
182 |                 className={
183 |                   profile.morningPerson && (profile.shareFood || profile.pets)
184 |                     ? ""
185 |                     : "d-none"
186 |                 }
187 |               >
188 |                 ,&nbsp;
189 |               </span>
190 |               <span className={profile.pets ? "" : "d-none"}>Pet-friendly</span>
191 |               <span
192 |                 className={profile.pets && profile.shareFood ? "" : "d-none"}
193 |               >
194 |                 ,&nbsp;
195 |               </span>
196 |               <span className={profile.shareFood ? "" : "d-none"}>
197 |                 Likes to share food
198 |               </span>
199 |             </li>
200 |             <li className="list-group-item bg-light">
201 |               <span className="fw-bold">Personality:&nbsp;</span>
202 |               <span className={profile.extrovert ? "" : "d-none"}>
203 |                 Extrovert
204 |               </span>
205 |               <span
206 |                 className={
207 |                   profile.extrovert &&
208 |                   (profile.introvert || profile.bringFriendsOver)
209 |                     ? ""
210 |                     : "d-none"
211 |                 }
212 |               >
213 |                 ,&nbsp;
214 |               </span>
215 |               <span className={profile.introvert ? "" : "d-none"}>
216 |                 Introvert
217 |               </span>
218 |               <span
219 |                 className={
220 |                   profile.introvert && profile.bringFriendsOver ? "" : "d-none"
221 |                 }
222 |               >
223 |                 ,&nbsp;
224 |               </span>
225 |               <span className={profile.bringFriendsOver ? "" : "d-none"}>
226 |                 Likes to bring friends over
227 |               </span>
228 |             </li>
229 |             <li className="list-group-item bg-light">
230 |               <span className="fw-bold">Important to Know:&nbsp;</span>
231 |               <span className={profile.loud ? "" : "d-none"}>Loud</span>
232 |               <span
233 |                 className={
234 |                   profile.loud &&
235 |                   (profile.messy || profile.smoker || profile.relationship)
236 |                     ? ""
237 |                     : "d-none"
238 |                 }
239 |               >
240 |                 ,&nbsp;
241 |               </span>
242 |               <span className={profile.messy ? "" : "d-none"}>Messy</span>
243 |               <span
244 |                 className={
245 |                   profile.messy && (profile.smoker || profile.relationship)
246 |                     ? ""
247 |                     : "d-none"
248 |                 }
249 |               >
250 |                 ,&nbsp;
251 |               </span>
252 |               <span className={profile.smoker ? "" : "d-none"}>
253 |                 Likes to smoke
254 |               </span>
255 |               <span
256 |                 className={
257 |                   profile.smoker && profile.relationship ? "" : "d-none"
258 |                 }
259 |               >
260 |                 ,&nbsp;
261 |               </span>
262 |               <span className={profile.relationship ? "" : "d-none"}>
263 |                 In a relationship
264 |               </span>
265 |             </li>
266 |             <li className="list-group-item bg-light"></li>
267 |           </ul>
268 |           {!params.username ? (
269 |             <Link to={`edit`} className="btn btn-primary btn-lg col-12 mt-3">
270 |               Edit Profile
271 |             </Link>
272 |           ) : sentRequest ? (
273 |             <button
274 |               type="button"
275 |               className="btn btn-primary btn-lg col-12 mt-3"
276 |               disabled={true}
277 |               onClick={handleSendRequest}
278 |             >
279 |               Roommate Request Sent!
280 |             </button>
281 |           ) : receivedRequest ? (
282 |             <button
283 |               type="button"
284 |               className="btn btn-primary btn-lg col-12 mt-3"
285 |               disabled={true}
286 |               onClick={handleSendRequest}
287 |             >
288 |               You have a request from this user!
289 |             </button>
290 |           ) : (
291 |             <div className={roommate ? "d-none" : ""}>
292 |               <TextAreaField
293 |                 label="Send a message with your request!"
294 |                 value={message}
295 |                 setValue={(message) => setMessage(message)}
296 |                 rowNum={3}
297 |               />
298 |               <button
299 |                 type="button"
300 |                 className="btn btn-primary btn-lg col-12"
301 |                 onClick={handleSendRequest}
302 |               >
303 |                 Send Roommate Request
304 |               </button>
305 |             </div>
306 |           )}
307 |         </div>
308 |         <RoommateList username={params.username ? params.username : false} />
309 |       </div>
310 |     </>
311 |   );
312 | };
313 | 


--------------------------------------------------------------------------------
/frontend/src/components/domain/Profile/ProfileEditor.jsx:
--------------------------------------------------------------------------------
  1 | import { useState, useEffect } from "react";
  2 | import { useNavigate, useLocation } from "react-router-dom";
  3 | import { useAuth, useAxiosPrivate } from "../../../hooks";
  4 | import {
  5 |   CheckBoxField,
  6 |   SelectField,
  7 |   TextField,
  8 |   TextAreaField,
  9 | } from "../../common";
 10 | import AvatarUpload from "./AvatarUpload";
 11 | import { Gender } from "../../../models";
 12 | 
 13 | export const ProfileEditor = () => {
 14 |   const { auth } = useAuth();
 15 |   const axiosPrivate = useAxiosPrivate();
 16 |   const navigate = useNavigate();
 17 |   const location = useLocation();
 18 | 
 19 |   const [profile, setProfile] = useState(undefined);
 20 | 
 21 |   const [nameReq, setNameReq] = useState(false);
 22 |   const [cityReq, setCityReq] = useState(false);
 23 | 
 24 |   const genders = [new Gender("male", "Man"), new Gender("female", "Woman")];
 25 | 
 26 |   useEffect(() => {
 27 |     const getProfile = async () => {
 28 |       try {
 29 |         const response = await axiosPrivate.get(`/user?email=${auth.username}`);
 30 |         setProfile(response.data[0]);
 31 |         return response.data[0];
 32 |       } catch (err) {
 33 |         console.error(err);
 34 |         navigate("/login", { state: { from: location }, replace: true });
 35 |       }
 36 |     };
 37 |     getProfile().then((x) => {
 38 |       if (x?.name) setNameReq(true);
 39 |       if (x?.city) setCityReq(true);
 40 |     });
 41 |   }, []);
 42 | 
 43 |   const mergeProfile = (delta) => {
 44 |     setProfile({ ...profile, ...delta });
 45 |     if (delta["name"] !== undefined) {
 46 |       checkLength(delta["name"], "name");
 47 |     }
 48 | 
 49 |     if (delta["city"] !== undefined) {
 50 |       checkLength(delta["city"], "city");
 51 |     }
 52 |     checkReq();
 53 |   };
 54 | 
 55 |   const checkLength = (delta, type) => {
 56 |     if (delta.length > 0 && type === "name") {
 57 |       setNameReq(true);
 58 |     } else if (delta.length === 0 && type === "name") {
 59 |       setNameReq(false);
 60 |     } else if (delta.length > 0 && type === "city") {
 61 |       setCityReq(true);
 62 |     } else {
 63 |       setCityReq(false);
 64 |     }
 65 |   };
 66 | 
 67 |   const checkReq = () => {
 68 |     if (!nameReq || !cityReq) {
 69 |       return false;
 70 |     }
 71 |     return true;
 72 |   };
 73 | 
 74 |   const handleSaveClick = async () => {
 75 |     const updateProfile = async (profile) => {
 76 |       try {
 77 |         await axiosPrivate.put(`/user`, profile);
 78 |       } catch (err) {
 79 |         console.error(err);
 80 |         navigate("/login", { state: { from: location }, replace: true });
 81 |       }
 82 |     };
 83 |     const updatePreferences = async (preferences) => {
 84 |       try {
 85 |         await axiosPrivate.put(`/user/preferences`, preferences);
 86 |       } catch (err) {
 87 |         console.error(err);
 88 |         navigate("/login", { state: { from: location }, replace: true });
 89 |       }
 90 |     };
 91 |     await updateProfile({
 92 |       email: profile.email,
 93 |       name: profile.name,
 94 |       age: profile.age,
 95 |       city: profile.city,
 96 |       bio: profile.bio,
 97 |       gender: profile.gender,
 98 |       hasResidence: profile.hasResidence,
 99 |       desired_roommates: profile.desired_roommates,
100 |     });
101 |     await updatePreferences({
102 |       email: profile.email,
103 |       apartment: profile.apartment,
104 |       house: profile.house,
105 |       condo: profile.condo,
106 |       nightPerson: profile.nightPerson,
107 |       morningPerson: profile.morningPerson,
108 |       extrovert: profile.extrovert,
109 |       introvert: profile.introvert,
110 |       smoker: profile.smoker,
111 |       bringFriendsOver: profile.bringFriendsOver,
112 |       loud: profile.loud,
113 |       shareFood: profile.shareFood,
114 |       messy: profile.messy,
115 |       pets: profile.pets,
116 |       relationship: profile.relationship,
117 |     });
118 |     navigate("/profile", { state: { from: location }, replace: true });
119 |   };
120 | 
121 |   if (!profile) {
122 |     return (
123 |       <>
124 |         <div className="container pt-4 pb-5 mb-4">
125 |           <div className="bg-light rounded p-5 pb-4 mb-4">
126 |             <div className="spinner-border" role="status">
127 |               <span className="visually-hidden">Loading Profile...</span>
128 |             </div>
129 |             <span className="fs-2 fw-bold">&nbsp;Loading Profile...</span>
130 |           </div>
131 |         </div>
132 |       </>
133 |     );
134 |   }
135 | 
136 |   return (
137 |     <>
138 |       <div className="container pt-4 pb-5 mb-4">
139 |         <div className="bg-light rounded p-3 p-md-5 pb-md-4 mb-4">
140 |           <div className="avatar-image float-sm-end mb-2">
141 |             <div className="image-wrapper">
142 |               <img
143 |                 src={
144 |                   profile.signedUrl ? profile.signedUrl : "/images/default.jpg"
145 |                 }
146 |                 alt="avatar"
147 |                 className="img-fluid"
148 |               />
149 |               <div className="overlay">
150 |                 <AvatarUpload
151 |                   username={profile.email}
152 |                   photoID={profile.photoID}
153 |                   onChange={(photoID, signedUrl) => {
154 |                     mergeProfile({ photoID, signedUrl });
155 |                   }}
156 |                 />
157 |               </div>
158 |             </div>
159 |           </div>
160 | 
161 |           <div className="text-center text-sm-start">
162 |             <h1>Create/Edit Your Profile</h1>
163 |             <h4>Username:&nbsp;({profile.email})</h4>
164 |           </div>
165 |           <div className="col-md-4">
166 |             <TextField
167 |               label="Name"
168 |               id="name"
169 |               value={profile.name}
170 |               required={true}
171 |               setValue={(name) => {
172 |                 mergeProfile({ name });
173 |               }}
174 |             />
175 |           </div>
176 |           <div className="col-md-4">
177 |             <TextField
178 |               label="Location/City"
179 |               id="city"
180 |               value={profile.city}
181 |               required={true}
182 |               setValue={(city) => {
183 |                 mergeProfile({ city });
184 |               }}
185 |             />
186 |           </div>
187 |           <div className="col-3 col-sm-2">
188 |             <SelectField
189 |               label="Gender"
190 |               value={profile.gender}
191 |               setValue={(gender) => mergeProfile({ gender })}
192 |               options={genders}
193 |               optionValueKey="id"
194 |               optionLabelKey="display"
195 |             />
196 |           </div>
197 |           <div className="col-2 col-md-1">
198 |             <SelectField
199 |               label="Age"
200 |               value={profile.age}
201 |               setValue={(age) => mergeProfile({ age })}
202 |               options={[...Array(85 - 18 + 1).keys()].map((x) => x + 18)}
203 |             />
204 |           </div>
205 |           <TextAreaField
206 |             label="About me"
207 |             value={profile.bio}
208 |             setValue={(bio) => mergeProfile({ bio })}
209 |             rowNum={4}
210 |           />
211 |           <div className="col-6 col-md-4">
212 |             <SelectField
213 |               label="How many roommates do you need?"
214 |               value={profile.desired_roommates}
215 |               setValue={(desired_roommates) =>
216 |                 mergeProfile({ desired_roommates })
217 |               }
218 |               options={[...Array(9).keys()].map((x) => x + 1)}
219 |             />
220 |           </div>
221 |           <CheckBoxField
222 |             label="Check this box if you have a residence."
223 |             checked={profile.hasResidence}
224 |             setChecked={(hasResidence) => mergeProfile({ hasResidence })}
225 |           />
226 |           <div>
227 |             <p className="mt-3 mb-0 fw-bold">
228 |               Select your property references.
229 |             </p>
230 |             <CheckBoxField
231 |               label="Apartment"
232 |               checked={profile.apartment}
233 |               setChecked={(apartment) => mergeProfile({ apartment })}
234 |             />
235 |             <CheckBoxField
236 |               label="House"
237 |               checked={profile.house}
238 |               setChecked={(house) => mergeProfile({ house })}
239 |             />
240 |             <CheckBoxField
241 |               label="Condo"
242 |               checked={profile.condo}
243 |               setChecked={(condo) => mergeProfile({ condo })}
244 |             />
245 |           </div>
246 |           <div>
247 |             <p className="mt-3 mb-0 fw-bold">
248 |               Select your lifestyle references.
249 |             </p>
250 |             <CheckBoxField
251 |               label="Night-owl"
252 |               checked={profile.nightPerson}
253 |               setChecked={(nightPerson) => mergeProfile({ nightPerson })}
254 |             />
255 |             <CheckBoxField
256 |               label="Early-bird"
257 |               checked={profile.morningPerson}
258 |               setChecked={(morningPerson) => mergeProfile({ morningPerson })}
259 |             />
260 |             <CheckBoxField
261 |               label="Pet-friendly"
262 |               checked={profile.pets}
263 |               setChecked={(pets) => mergeProfile({ pets })}
264 |             />
265 |             <CheckBoxField
266 |               label="Likes to share food"
267 |               checked={profile.shareFood}
268 |               setChecked={(shareFood) => mergeProfile({ shareFood })}
269 |             />
270 |           </div>
271 |           <div>
272 |             <p className="mt-3 mb-0 fw-bold">
273 |               Select traits that describe you.
274 |             </p>
275 |             <CheckBoxField
276 |               label="Extrovert"
277 |               checked={profile.extrovert}
278 |               setChecked={(extrovert) => mergeProfile({ extrovert })}
279 |             />
280 |             <CheckBoxField
281 |               label="Introvert"
282 |               checked={profile.introvert}
283 |               setChecked={(introvert) => mergeProfile({ introvert })}
284 |             />
285 |             <CheckBoxField
286 |               label="I like to bring friends over"
287 |               checked={profile.bringFriendsOver}
288 |               setChecked={(bringFriendsOver) =>
289 |                 mergeProfile({ bringFriendsOver })
290 |               }
291 |             />
292 |           </div>
293 |           <div>
294 |             <p className="mt-3 mb-0 fw-bold">
295 |               Select what your potential roommates should know about you.
296 |             </p>
297 |             <CheckBoxField
298 |               label="Loud"
299 |               checked={profile.loud}
300 |               setChecked={(loud) => mergeProfile({ loud })}
301 |             />
302 |             <CheckBoxField
303 |               label="Messy"
304 |               checked={profile.messy}
305 |               setChecked={(messy) => mergeProfile({ messy })}
306 |             />
307 |             <CheckBoxField
308 |               label="I smoke"
309 |               checked={profile.smoker}
310 |               setChecked={(smoker) => mergeProfile({ smoker })}
311 |             />
312 |             <CheckBoxField
313 |               label="I am in a relationship"
314 |               checked={profile.relationship}
315 |               setChecked={(relationship) => mergeProfile({ relationship })}
316 |             />
317 |           </div>
318 |           {checkReq() && (
319 |             <button
320 |               className="btn btn-primary btn-lg col-12 mt-3"
321 |               onClick={handleSaveClick}
322 |             >
323 |               Save Changes
324 |             </button>
325 |           )}
326 |           {!checkReq() && (
327 |             <div className="card text-center text-bg-primary opacity-50 fs-5 col-12 mt-3 p-2">
328 |               Save Changes
329 |             </div>
330 |           )}
331 |         </div>
332 |       </div>
333 |     </>
334 |   );
335 | };
336 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------