doc: add prep exercise of week 3

allhandsondeck · stasel · commit ad2769f28fde · 2024-02-28T14:10:17.000+01:00
diff --git a/week3/build-with-students/app.js b/week3/build-with-students/app.js
diff --git a/week3/build-with-students/users.js b/week3/build-with-students/users.js
diff --git a/week3/prep-exercise/README.md b/week3/prep-exercise/README.md
@@ -0,0 +1,32 @@
+In this exercise, you will build a secure authentication and authorisation system using Node.js and Express.js with four main endpoints: register, login, getProfile, and logout. The system will utilise JWT (JSON Web Tokens) for managing user sessions.
+
+Requirements:
+
+1. Register Endpoint:
+
+   - Implement a POST endpoint /register that allows users to register with a username and password.
+   - Validate the request body to ensure it includes a username and password.
+   - Hash the user's password using bcrypt before storing it in memory.
+   - Return a success message along with the user's ID and username upon successful registration.
+
+1. Login Endpoint:
+
+   - Create a POST endpoint /login that allows users to log in with their registered credentials.
+   - Validate the request body to ensure it includes a username and password.
+   - Verify the user's credentials by comparing the hashed password stored in memory.
+   - If authentication succeeds, generate a JWT containing the user's ID and sign it with a secret key.
+   - Return the JWT token to the client upon successful login.
+
+1. Get Profile Endpoint:
+
+   - Implement a GET endpoint /profile that allows authenticated users to retrieve their profile information.
+   - Extract the JWT token from the Authorization header.
+   - Verify the JWT token and decode the payload to retrieve the user's ID.
+   - Retrieve the user's profile information from memory using the decoded user ID.
+   - Return a message with the user's username upon successful profile retrieval.
+
+1. Logout Endpoint:
+
+   - Create a POST endpoint /logout that allows users to logout and invalidate their JWT token.
+   - No server-side token invalidation is required; the client should handle token deletion.
+   - Return a success response with a status code indicating successful logout (e.g., 204 No Content).
diff --git a/week3/prep-exercise/app.js b/week3/prep-exercise/app.js
@@ -0,0 +1,12 @@
+import express from "express";
+// Use below import statement for importing middlewares from users.js for your routes
+// import { ....... } from "./users.js";
+
+let app = express();
+
+app.use(express.json());
+// Create routes here, e.g. app.post("/register", .......)
+
+app.listen(3000, () => {
+  console.log("Server is running on port 3000");
+});
diff --git a/week3/prep-exercise/package.json b/week3/prep-exercise/package.json
@@ -11,8 +11,6 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "bcrypt": "^5.1.1",
     "express": "^4.18.2",
-    "uuid": "^9.0.1"
   }
-}
+}
diff --git a/week3/prep-exercise/users.js b/week3/prep-exercise/users.js
@@ -0,0 +1,4 @@
+// Create middlewares required for routes defined in app.js
+// export const register = async (req, res) => {};
+
+// You can also create helper functions in this file to help you implement logic inside middlewares
