Happy thoughts API - Project hand-in

README.md

@@ -1,11 +1,69 @@
-# Project API
 
-This project includes the packages and babel setup for an express server, and is just meant to make things a little simpler to get up and running with.
+# Happy Thoughts API
 
-## Getting started
+render link: https://happy-thoughts-api-o47r.onrender.com
 
-Install dependencies with `npm install`, then start the server by running `npm run dev`
+This project is a RESTful API built with **Node.js**, **Express**, and **MongoDB** (via Mongoose) that allows users to create, view, manage, and "like" happy thoughts. It also includes user authentication features to secure content management actions.
 
-## View it live
+## 🚀 Key Features
 
-Every project should be deployed somewhere. Be sure to include the link to the deployed project so that the viewer can click around and see what it's all about.
+*   **User Management:**
+    *   **Signup:** Register new users with email, first name, last name, and hashed passwords (using `bcrypt`).
+    *   **Login:** Authenticate users and receive an `accessToken` for protected requests.
+*   **Happy Thoughts Management:**
+    *   **Create:** Authenticated users can post happy thoughts.
+    *   **Read:** View all thoughts (supports filtering by minimum likes) or fetch a specific thought by ID.
+    *   **Update:** Authenticated users can edit their own thoughts.
+    *   **Delete:** Authenticated users can delete their own thoughts.
+    *   **Like:** Users can "like" (increment the heart count) any happy thought.
+*   **Security:**
+    *   Authentication middleware verifies user `accessToken` for sensitive operations (creating, updating, deleting).
+    *   Authorization checks ensure users can only modify thoughts they own.
+    *   Password hashing and email validation.
+
+## 🛠 Tech Stack
+
+*   **Runtime:** Node.js
+*   **Framework:** Express.js
+*   **Database:** MongoDB
+*   **ODM:** Mongoose
+*   **Security:** `bcrypt` (password hashing), `crypto` (access token generation)
+*   **Utilities:** `cors`, `dotenv` (environment variables), `express-list-endpoints`
+
+## 📡 API Endpoints
+
+### User Routes (`/users`)
+
+| Method | Endpoint | Description | Auth Required |
+| :--- | :--- | :--- | :--- |
+| `POST` | `/signup` | Register a new user | No |
+| `POST` | `/login` | Authenticate user | No |
+| `GET` | `/:id` | Get user profile | No |
+
+### Happy Thoughts Routes (`/happy-thoughts`)
+
+| Method | Endpoint | Description | Auth Required |
+| :--- | :--- | :--- | :--- |
+| `GET` | `/` | List thoughts (query: `minLikes`) | No |
+| `POST` | `/` | Create a new thought | Yes |
+| `GET` | `/:id` | Get a specific thought | No |
+| `PATCH` | `/:id` | Update a thought | Yes |
+| `DELETE` | `/:id` | Delete a thought | Yes |
+| `PATCH` | `/:id/like` | Like a thought | No |
+
+## ⚙️ Setup & Configuration
+
+1.  **Clone the repository.**
+2.  **Install dependencies:**
+    ```bash
+    npm install
+    ```
+3.  **Environment Variables:**
+    Create a `.env` file in the root directory and define the following:
+    ```text
+    MONGO_URL=your_mongodb_connection_string
+    ```
+4.  **Run the server:**
+    ```bash
+    npm run dev
+    ```

middleware/authMiddleware.js

@@ -0,0 +1,33 @@
+import { User } from "../models/User.js"
+
+export const authenticateUser = async (request, response, next) => {
+  try {
+
+    const authHeader = request.header("Authorization") || request.get("Authorization")
+
+    if(!authHeader) {
+      return response.status(401).json({
+        message: "Authentication missing or invalid",
+        loggedOut: true
+      })
+    }
+
+    const user = await User.findOne({ accessToken: authHeader.replace("Bearer ", "")})
+
+    if (user) {
+      request.user = user
+      next()
+    } else {
+      response.status(401).json({
+        message: "Authentication missing or invalid",
+        loggedOut: true
+      })
+    }
+
+  } catch (error) {
+    response.status(500).json({
+      message: "internal server error",
+      error: error.message
+    })
+  }
+}

models/HappyThought.js

@@ -0,0 +1,22 @@
+import mongoose from "mongoose"
+
+const happyThoughtSchema = new mongoose.Schema({
+  message: {
+    type: String,
+    required: true
+  },
+  hearts: {
+    type: Number
+  },
+  createdAt: {
+    type: Date,
+    default: Date.now
+  },
+  author: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: "User",
+    required: true
+  }
+})
+
+export const HappyThought = mongoose.model("HappyThought", happyThoughtSchema)

models/User.js

@@ -0,0 +1,28 @@
+import crypto from "crypto"
+import mongoose from "mongoose"
+
+const userSchema = new mongoose.Schema({
+  firstName: {
+    type: String,
+    required: true
+  },
+  lastName: {
+    type: String,
+    required: true
+  },
+  email: {
+    type: String,
+    required: true,
+    unique: true
+  },
+  password: {
+    type: String,
+    required: true
+  },
+  accessToken: {
+    type: String,
+    default: () => crypto.randomBytes(128).toString("hex")
+  }
+})
+
+export const User = mongoose.model("User", userSchema)

package.json

@@ -2,6 +2,7 @@
   "name": "project-api",
   "version": "1.0.0",
   "description": "Project API",
+  "type": "module",
   "scripts": {
     "start": "babel-node server.js",
     "dev": "nodemon server.js --exec babel-node"
@@ -12,8 +13,13 @@
     "@babel/core": "^7.17.9",
     "@babel/node": "^7.16.8",
     "@babel/preset-env": "^7.16.11",
-    "cors": "^2.8.5",
-    "express": "^4.17.3",
+    "bcrypt": "^6.0.0",
+    "cors": "^2.8.6",
+    "dotenv": "^17.2.3",
+    "express": "^4.22.1",
+    "express-list-endpoints": "^7.1.1",
+    "mongodb": "^7.2.0",
+    "mongoose": "^9.5.0",
     "nodemon": "^3.0.1"
   }
 }