crud-api-express 1.0.0 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "crud-api-express",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "description": "",
   "main": "dist/index.js",

package/readme.md

@@ -1,6 +1,6 @@
 # CRUD API Controller using Express and Mongoose
 
-npm install crud-api
+npm install crud-api-express
 
 
 This project provides a flexible and reusable CRUD (Create, Read, Update, Delete) API controller for MongoDB using Express.js and Mongoose.
@@ -33,39 +33,55 @@ To use `CrudController` in your Node.js project, follow these steps:
 Here's a basic example of how to use CrudController:
 
 
-import express, { Request, Response } from 'express';
-import mongoose, { Document, Model } from 'mongoose';
-import CrudController, { CrudOptions } from 'crud-api';
+import express from 'express';
+import mongoose from 'mongoose';
+import CrudController from 'crud-api-express'; // Path to your CrudController file
 
-// Define your Mongoose schema and model
-interface ExampleModel extends Document {
-  name: string;
-  age: number;
-}
+// Define Mongoose schema and model
+const Schema = mongoose.Schema;
 
-const ExampleSchema = new mongoose.Schema<ExampleModel>({
-  name: { type: String, required: true },
-  age: { type: Number, required: true },
-});
+const ExampleSchema = new Schema({
+    title: { type: String, required: true, trim: true },
+    type: { type: String, default: 'Percentage', enum: ['Percentage', 'Flat'] },
+    value: { type: Number, required: true },
+    status: { type: String, default: 'Active', trim: true },
+    expiry_date: { type: Date, index: true, trim: true },
+}, { timestamps: true, versionKey: false });
 
-const ExampleModel = mongoose.model<ExampleModel>('Example', ExampleSchema);
+const ExampleModel = mongoose.model('Example', ExampleSchema);
 
 // Create an instance of CrudController
-const exampleController = new CrudController<ExampleModel>(ExampleModel, 'examples', {
-  // Optional configuration
+const exampleController = new CrudController(ExampleModel, 'examples', {
+  // Optional configuration options here
 });
 
-// Create Express application
-const app = express();
-
-// Mount the CrudController router
-app.use('/api/examples', exampleController.getRouter());
-
-// Start the server
-const PORT = process.env.PORT || 3000;
-app.listen(PORT, () => {
-  console.log(`Server is running on port ${PORT}`);
-});
+// MongoDB Atlas connection URI
+const mongoURI = 'mongodb+srv';
+
+// Connect to MongoDB Atlas
+mongoose.connect(mongoURI, { useNewUrlParser: false, useUnifiedTopology: false })
+  .then(() => {
+    console.log('Connected to MongoDB Atlas');
+    // Start the Express server after successful connection
+    const app = express();
+
+    // Middleware to parse JSON bodies
+    app.use(express.json());
+
+
+    // Mount the CrudController router
+    app.use('/api', exampleController.getRouter());
+
+    // Start the server
+    const PORT = process.env.PORT || 3000;
+    app.listen(PORT, () => {
+      console.log(`Server is running on port ${PORT}`);
+    });
+  })
+  .catch(err => {
+    console.error('Error connecting to MongoDB Atlas:', err.message);
+    process.exit(1); // Exit process with failure
+  });
 
 
 # API