Bangu Blogs Server

• Live Server Link

📑 Table of Contents

1. Overview
2. Key Features of Bangu Blogs Server
3. Technologies (Packages) Used
4. Run the Server Locally
   • Prerequisites
   • Installation
5. Authentication
   • User Registration
   • User Login
6. Blog Management
   • Create Blog
   • Update Blog
   • Delete Blog
7. Admin Actions
   • Block User
   • Delete Blog (Admin)
8. Search, Sort & Filter Blogs
9. Error Handling
10. Custom Progress Indicators
11. Project Overview Video
12. Admin Credentials

📚 Overview

Bangu Blogs Server is a robust backend application built for managing blogs with user authentication, role-based access control, and comprehensive API functionalities. It supports both Admin and User roles with tailored permissions and features.

🚀 Key Features of Bangu Blogs Server

1. User Authentication & Authorization: Secure login with role-based access control (Admin, User).
2. Role Management: Admins can block users and manage all blogs, while users can manage their own content.
3. JWT-Based Security: Access and refresh tokens ensure secure session management.
4. Middleware Protection: Role-based access enforced through middleware (authorizeUser).
5. Blog Management: Full CRUD operations for blogs, with ownership validation.
6. Search, Sort & Filter: Efficient querying powered by a reusable QueryBuilder class, designed to support future module expansions.
7. Password Encryption: User passwords are securely hashed using bcrypt.
8. Data Validation: Input validated with Zod schemas to ensure data integrity.
9. Scalable Architecture: Modular and well-structured backend code for maintainability.

⚙️ Technologies (Packages) Used

🛠️ Core Technologies

• TypeScript – Typed JavaScript for better scalability and maintainability.
• Node.js – JavaScript runtime environment.
• Express.js – Fast, unopinionated web framework for Node.js.
• Mongoose – Elegant MongoDB object modeling for Node.js.

🔒 Authentication & Security

• bcrypt – Library for hashing passwords.
• jsonwebtoken – Implementation of JSON Web Tokens for authentication.
• cookie-parser – Middleware to parse cookies in requests.

✅ Validation

• zod – TypeScript-first schema validation library.

🌍 Cross-Origin Resource Sharing

• cors – Middleware for enabling CORS in Express.

⚙️ Environment Configuration

• dotenv – Loads environment variables from a .env file.

🛡️ Code Quality & Formatting

• eslint – Linter for identifying problematic patterns in code.
• prettier – Code formatter for consistent styling.

📦 Build & Development Utilities

• chalk – Terminal string styling for improved CLI output.
• progress-estimator – Estimate and display task progress.
• execa – Better child_process management.
• rimraf – Cross-platform tool for recursive file deletion.
• globby – Advanced globbing library for file matching (in build.mjs).
• nodemon – Utility for automatically restarting the server during development.
• ts-node – Run TypeScript in development directly without manual compilation.

🛠️ Run the Server Locally

Prerequisites

• Node.js (Preferred v22+)
• pnpm package manager
• If you prefer npm or yarn over pnpm, delete pnpm-lock.yaml file and follow the steps below.

Installation

1. Clone the repository:

   git clone https://github.com/nazmul-nhb/bangu-blogs-server.git
   cd bangu-blogs-server

2. Install dependencies:

   pnpm install

   for npm:

   npm install

   for yarn:

   yarn install

3. Set up environment variables: Create a .env file in the root directory with the following fields:

    NODE_ENV=development
    PORT=4242 or any port number
    SALT_ROUNDS=<number>
    MONGO_URI=your_mongo_db_uri
    JWT_ACCESS_SECRET=secret_string_for_access_token
    JWT_ACCESS_EXPIRES_IN=expiry_time (1h, 1d etc.)
    JWT_REFRESH_SECRET=secret_string_for_refresh_token
    JWT_REFRESH_EXPIRES_IN=expiry_time (1h, 1d etc.)

4. Start the development server:

    pnpm dev

   for npm:

    npm run dev

   for yarn:

    yarn run dev

5. Access the API at:

   http://localhost:4242

---

🔑 Authentication

User Registration

• Endpoint: POST /api/auth/register

• Description: Register a new user.

• Request Body:

  {
    "name": "John Doe",
    "email": "john@example.com",
    "password": "123456"
  }

• Response:

  {
    "success": true,
    "message": "User registered successfully!",
    "statusCode": 201,
    "data": {
      "_id": "string",
      "name": "string",
      "email": "string"
    }
  }

User Login

• Endpoint: POST /api/auth/login

• Description: Authenticate a user and retrieve a JWT token.

• Request Body:

  {
    "email": "john@example.com",
    "password": "123456"
  }

• Response:

  {
    "success": true,
    "message": "Login successful!",
    "statusCode": 200,
    "data": {
      "token": "string"
    }
  }

---

📖 Blog Management

Create Blog

• Endpoint: POST /api/blogs

• Description: Create a new blog (User only).

• Request Header:

  Authorization: Bearer <token>

• Request Body:

  {
    "title": "My First Blog",
    "content": "This is my blog content."
  }

• Response:

  {
    "success": true,
    "message": "Blog created successfully!",
    "statusCode": 201,
    "data": {
      "_id": "string",
      "title": "My First Blog",
      "content": "This is my blog content.",
      "author": {
        "_id": "author id",
        "name": "author name",
        "email": "author email"
       }
     }
  }

Update Blog

• Endpoint: PATCH /api/blogs/:id

• Description: Update an existing blog (User only).

• Request Header:

  Authorization: Bearer <token>

• Request Body:

  {
    "title": "Updated Blog Title",
    "content": "Updated content."
  }

• Response

  {
  "success": true,
  "message": "Blog updated successfully",
  "statusCode": 200,
  "data": {
     "_id": "string",
     "title": "string",
     "content": "string",
     "author": {
       "_id": "author id",
       "name": "author name",
       "email": "author email"
      }
    }
  }

Delete Blog

• Endpoint: DELETE /api/blogs/:id

• Description: Delete a blog (User).

• Request Header:

  Authorization: Bearer <token>

• Response

  {
   "success": true,
   "message": "Blog deleted successfully!",
   "statusCode": 200
  }

---

⚙️ Admin Actions

Block User

• Endpoint: PATCH /api/admin/users/:userId/block

• Description: Allows an admin to block a user by updating the isBlocked property to true.

• Request Header:

  Authorization: Bearer <admin_token>

• Response

  {
   "success": true,
   "message":"User blocked successfully!",
   "statusCode": 200
  }

Delete Blog (Admin)

• Endpoint: DELETE /api/admin/blogs/:id

• Description: Delete any blog.

• Request Header:

  Authorization: Bearer <admin_token>

• Response

  {
   "success": true,
   "message": "Blog deleted successfully!",
   "statusCode": 200
  }

---

📊 Search, Sort & Filter Blogs

• Endpoint: GET /api/blogs
• Query Parameters:
  • search: Search blogs by title or content (e.g., search=productivity).
  • sortBy: Sort blogs by specific fields such as createdAt or title (e.g., sortBy=title).
  • sortOrder: Defines the sorting order. Accepts values asc (ascending) or desc (descending). (e.g., sortOrder=desc).
  • filter: Filter blogs by author ID (e.g., author=authorId).

Example Request URL:

/api/blogs?search=productivity&sortBy=title&sortOrder=desc&filter=676652d0b7adefd7d645a727

In this example:

• search=technology: Filters blogs containing the term "technology" in the title or content.
• sortBy=title: Sorts the blogs by the title field.
• sortOrder=desc: Sorts in descending order (newest blogs first).
• filter=676652d0b7adefd7d645a727: Filters blogs authored by the user with the given authorId.

Response:

{
  "success": true,
  "message": "Blogs fetched successfully!",
  "statusCode": 200,
  "data": [
    {
      "_id": "string",
      "title": "string",
      "content": "string",
      "author": {
        "_id": "author id",
        "name": "author name",
        "email": "author email"
      }
    },
    {...}
  ]
}

---

🐞 Error Handling

All error responses follow a consistent structure:

{
  "success": false,
  "message": "Error message",
  "statusCode": 400,
  "error": { "details": [
         {
           "name": "Error name",
           "path": "where error occurred if traced",
           "message": "Error message"
         },
         {...}
      ]
   },
  "stack": "Error stack trace if available"
}

---

📊 Custom Progress Indicators

Implemented custom progress indicators using progress-estimator, globby and chalk for key development tasks to improve visibility and clarity during long-running processes:

• Build: pnpm build – Displays progress while building the project.
• Lint: pnpm lint – Provides real-time progress feedback during linting.
• Fix: pnpm fix – Tracks progress while auto-fixing linting issues.
• Deploy: pnpm run deploy – Builds the project and deploys it to Vercel with production settings, displaying progress for both stages.

---

📹 Project Overview Video

• Project Overview Video Link

---

🧠 Admin Credentials

• Email: admin@bangu.com
• Password: 123456