Merge pull request #2 from Tianyou-Xie/dev

Sprint 3 Deliverables
Tianyou-Xie · May 17, 2024 · 4fe534d · 4fe534d
2 parents ad0e7a1 + dcd72bc
commit 4fe534d
Show file tree

Hide file tree

Showing 109 changed files with 5,476 additions and 83 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,3 +1,5 @@
 {
-	"cssModules.camelCase": true
+	"cssModules.camelCase": true,
+	"editor.formatOnSave": true,
+	"files.autoSave": "afterDelay"
 }
diff --git a/README.md b/README.md
@@ -15,15 +15,19 @@ An interplanetary town square that maintains connections between cultures and id
 -   Samarjit Bhogal ([@SamarjitBhogal](https://github.com/SamarjitBhogal))
 -   Marcus Lages ([@MarcusLages](https://github.com/MarcusLages))
 
-## Core Technologies
+## Technologies
 
-The project is built using Typescript, and split into two modules, the client and server.
+The project is built using [Typescript](https://www.typescriptlang.org/), and split into two modules, the client and server.
 
 **Client (built with [Vite](https://vitejs.dev/)):**
 
 -   [React](https://react.dev/)
+-   [React Bootstrap](https://react-bootstrap.netlify.app/)
+-   [React Icons](https://react-icons.github.io/react-icons/)
 -   [Wouter](https://www.npmjs.com/package/wouter)
 -   [CSS Modules](https://github.com/css-modules/css-modules) (implemented by Vite)
+-   [Bootstrap](https://getbootstrap.com/)
+-   [axios](https://axios-http.com/)
 
 **Server (built with [esno](https://www.npmjs.com/package/esno)):**
 
@@ -32,10 +36,21 @@ The project is built using Typescript, and split into two modules, the client an
 -   [Express](https://expressjs.com/)
 -   [Express File Routing](https://www.npmjs.com/package/express-file-routing)
 -   [Joi](https://joi.dev/)
+-   [bcrypt](https://github.com/kelektiv/node.bcrypt.js)
+-   [http-status-codes](https://www.npmjs.com/package/http-status-codes)
+-   [nodemailer](https://www.nodemailer.com/)
+-   [JWT](https://jwt.io/)
 
-**Repository Management:**
+**Development Utilities:**
 
 -   [Prettier](https://prettier.io/) for consistent code formatting, see `.prettierrc`.
+-   [morgan](https://expressjs.com/en/resources/middleware/morgan.html) for request logging
+-   [picocolors](https://www.npmjs.com/package/picocolors) for adding colour to request logging
+
+## Code Attributions
+
+-   Regex escape utility: [(`./server/utils/regex.ts:10`)](https://github.com/Tianyou-Xie/2800_202410_BBY07/blob/dev/server/src/utils/regex.ts#L10)
+    > https://github.com/component/escape-regexp/blob/master/index.js
 
 ## Environment Variables
 
@@ -51,15 +66,18 @@ Both the server and client utilize a `.env` file.
 
 **Client Variables:**
 
-(TODO)
+| Key  | Usage                          |
+| ---- | ------------------------------ |
+| PORT | Port used for the frontend app |
 
 **Server Variables:**
 
-MongoDB variables coming soon (TODO)
-
-| Key  | Usage                            |
-| ---- | -------------------------------- |
-| PORT | Port used for the express server |
+| Key        | Usage                                         |
+| ---------- | --------------------------------------------- |
+| PORT       | Port used for the express server              |
+| MONGO_URL  | The MongoDB connection string                 |
+| JWT_TTL    | The JWT token expiry time, in seconds         |
+| JWT_SECRET | The secret used to sign and verify JWT tokens |
 
 ## Running Locally & Deployment
 

diff --git a/client/index.html b/client/index.html
@@ -3,10 +3,11 @@
 	<head>
 		<meta charset="UTF-8" />
 		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<link rel="icon" type="image/ico" href="/favicon.ico" />
 		<title>Skynet</title>
 	</head>
 	<body>
-		<div id="root"></div>
+		<div id="root" class="h-100 w-100"></div>
 		<script type="module" src="/src/index.tsx"></script>
 	</body>
 </html>