MongoDB Database

A modular MongoDB integration for Express with Mongoose, featuring dynamic model registration, CRUD APIs, and built-in support for auth components like auth-jwt.

databasemongodbmongoosecrudjavascriptexpressauthscalable

v3.1.0database

Overview

A powerful, modular MongoDB integration for Express using Mongoose. This component provides a shared database layer that is automatically reused by authentication and other Backternity modules (like auth-jwt, aws-s3-upload, and logger-winston). It supports dynamic model registration and discriminator-based extensions — perfect for scalable systems.

Installation

CLI

npx backternity add database-mongodb

What This Does

Installs a shared MongoDB integration for Express with Mongoose and dynamic model management. Designed to work standalone or as a foundation for other components like auth-jwt.

Files & Folders Created

File / Path	Description
/src/config/database.js	Shared MongoDB connection logic.
/src/models/index.js	Registers base User and Product models.
/src/routes/crud.js	Provides generic CRUD endpoints for all models.
/server.js.example	Example integration for Express app.
/.env.example	Environment variables for MongoDB configuration.

Files to be modified

File / Path	Description
server.js	Adds MongoDB connection setup.
src/models	Can be extended dynamically via discriminators.

Configuration

# MongoDB Configuration
MONGODB_URI=mongodb://localhost:27017/backternity-app
NODE_ENV=development
PORT=3000

Frontend Integration

You can interact with any registered model (like `User` or `Product`) using these CRUD API endpoints. Below is a Next.js example for fetching, creating, and updating documents.

POST/api/crud/Product

Create a new product document.

GET/api/crud/Product

Fetch all products (supports query filters).

PUT/api/crud/Product/64f8a4b2c1234567890abcde

Update a specific product by its ID.

DELETE/api/crud/Product/64f8a4b2c1234567890abcde

Delete a specific product by its ID.

GET/api/crud/Product/64f8a4b2c1234567890abcde

Fetch a specific product by its ID.

Example

// app/components/ProductManager.jsx
'use client';
import { useState, useEffect } from 'react';

export default function ProductManager() {
  const [products, setProducts] = useState([]);
  const [form, setForm] = useState({ name: '', price: '' });

  // Fetch all products
  async function fetchProducts() {
    const res = await fetch('/api/crud/Product');
    const data = await res.json();
    setProducts(data);
  }

  // Create a new product
  async function addProduct() {
    await fetch('/api/crud/Product', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify(form)
    });
    setForm({ name: '', price: '' });
    fetchProducts();
  }

  useEffect(() => {
    fetchProducts();
  }, []);

  return (
    <div className="max-w-lg mx-auto bg-black/20 p-6 rounded-xl border border-white/10 text-white space-y-4">
      <h2 className="text-xl font-semibold">MongoDB Product Manager</h2>

      <div className="space-y-2">
        <input
          placeholder="Product Name"
          className="w-full p-2 rounded bg-black/40 border border-white/20 text-white"
          value={form.name}
          onChange={(e) => setForm({ ...form, name: e.target.value })}
        />
        <input
          placeholder="Price"
          type="number"
          className="w-full p-2 rounded bg-black/40 border border-white/20 text-white"
          value={form.price}
          onChange={(e) => setForm({ ...form, price: e.target.value })}
        />
        <button
          onClick={addProduct}
          className="w-full bg-emerald-600 hover:bg-emerald-700 py-2 rounded-md font-semibold"
        >
          Add Product
        </button>
      </div>

      <div className="mt-6">
        <h3 className="text-lg font-medium mb-2">Available Products</h3>
        {products.length === 0 ? (
          <p className="text-sm text-gray-400">No products found.</p>
        ) : (
          <ul className="space-y-1">
            {products.map((p) => (
              <li
                key={p._id}
                className="p-2 bg-black/30 rounded-md border border-white/10"
              >
                {p.name} — ₹{p.price}
              </li>
            ))}
          </ul>
        )}
      </div>
    </div>
  );
}

Usage

// Example CRUD usage in Express
const express = require('express');
const app = express();
const crudRoutes = require('./src/routes/crud');
const connectMongoDB = require('./src/config/database');
connectMongoDB();

app.use('/api/crud', crudRoutes);

app.listen(3000, () => console.log('MongoDB CRUD API running'));