first commit

Author: Rahad-Ullah

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.gitignore

@@ -0,0 +1,6 @@
+node_modules
+.env
+dist
+
+/winston
+/uploads

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "arrowParens": "avoid"
+}

README.md

@@ -0,0 +1,114 @@
+# Project Name
+
+This is a template project for backend development using Typescript, Node.js, Express, Mongoose, Bcrypt, JWT, NodeMailer, Multer, ESLint, and Prettier. The aim is to reduce setup time for new backend projects.
+
+## Features
+
+- **Authentication API:** Complete authentication system using JWT for secure token-based authentication and bcrypt for password hashing.
+- **File Upload:** Implemented using Multer with efficient file handling and short-term storage.
+- **Data Validation:** Robust data validation using Zod and Mongoose schemas.
+- **Code Quality:** Ensured code readability and quality with ESLint and Prettier.
+- **Email Service:** Sending emails through NodeMailer.
+- **File Handling:** Efficient file deletion using `fs.unlink`.
+- **Environment Configuration:** Easy configuration using a `.env` file.
+- **Logging:** Logging with Winston and file rotation using DailyRotateFile.
+- **API Request Logging:** Logging API requests using Morgan.
+
+## Tech Stack
+
+- Typescript
+- Node.js
+- Express
+- Mongoose
+- Bcrypt
+- JWT
+- NodeMailer
+- Multer
+- ESLint
+- Prettier
+- Winston
+- Daily-winston-rotate-file
+- Morgen
+- Socket
+
+## Getting Started
+
+Follow these steps to set up and run the project locally.
+
+### Prerequisites
+
+Ensure you have the following installed:
+
+- Node.js
+- npm or yarn
+
+### Installation
+
+1. **Clone the repository:**
+
+   ```bash
+   git clone https://github.com/yourusername/your-repository.git
+   cd your-repository
+   ```
+
+2. **Install dependencies:**
+
+   Using npm:
+
+   ```bash
+   npm install
+   ```
+
+   Using yarn:
+
+   ```bash
+   yarn install
+   ```
+
+3. **Create a `.env` file:**
+
+   In the root directory of the project, create a `.env` file and add the following variables. Adjust the values according to your setup.
+
+   ```env
+   # Basic
+   NODE_ENV=development
+   DATABASE_URL=mongodb://127.0.0.1:27017/project_name
+   IP_ADDRESS=192.0.0.0
+   PORT=5000
+
+   # Bcrypt
+   BCRYPT_SALT_ROUNDS=12
+
+   # JWT
+   JWT_SECRET=jwt_secret
+   JWT_EXPIRE_IN=1d
+
+   # Email
+   EMAIL_FROM=email@gmail.com
+   EMAIL_USER=email@gmail.com
+   EMAIL_PASS=mkqcfjeqloothyax
+   EMAIL_PORT=587
+   EMAIL_HOST=smtp.gmail.com
+   ```
+
+4. **Run the project:**
+
+   Using npm:
+
+   ```bash
+   npm run dev
+   ```
+
+   Using yarn:
+
+   ```bash
+   yarn run dev
+   ```
+
+### Running the Tests
+
+Explain how to run the automated tests for this system.
+
+```bash
+npm test
+```

package.json

@@ -0,0 +1,54 @@
+{
+  "name": "backend-template-typescript-mongoose-express",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "dev": "ts-node-dev --respawn --transpile-only src/server.ts",
+    "start": "node dist/server.js",
+    "build": "tsc",
+    "lint:check": "eslint --ignore-path .eslintignore --ext .js,.ts",
+    "lint:fix": "lint . --fix",
+    "prettier:check": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\"",
+    "prettier:fix": "prettier --write .",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "Rahad-Ullah",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/bcrypt": "^5.0.2",
+    "@types/bcryptjs": "^2.4.6",
+    "@types/cors": "^2.8.17",
+    "@types/express": "^4.17.21",
+    "@types/jsonwebtoken": "^9.0.6",
+    "@types/morgan": "^1.9.9",
+    "@types/multer": "^1.4.11",
+    "@types/nodemailer": "^6.4.15",
+    "@typescript-eslint/eslint-plugin": "^7.15.0",
+    "@typescript-eslint/parser": "^7.15.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.5.3"
+  },
+  "dependencies": {
+    "bcrypt": "^5.1.1",
+    "colors": "^1.4.0",
+    "cors": "^2.8.5",
+    "dotenv": "^16.4.5",
+    "express": "^4.19.2",
+    "http-status-codes": "^2.3.0",
+    "i": "^0.3.7",
+    "jsonwebtoken": "^9.0.2",
+    "mongoose": "^8.4.4",
+    "morgan": "^1.10.0",
+    "multer": "^1.4.5-lts.1",
+    "nodemailer": "^6.9.14",
+    "npm": "^10.8.1",
+    "socket.io": "^4.7.5",
+    "winston": "^3.13.0",
+    "winston-daily-rotate-file": "^5.0.0",
+    "zod": "^3.23.8"
+  }
+}

src/DB/seedAdmin.ts

@@ -0,0 +1,23 @@
+import { User } from '../app/modules/user/user.model';
+import config from '../config';
+import { USER_ROLES } from '../enums/user';
+import { logger } from '../shared/logger';
+
+const payload = {
+  name: 'Administrator',
+  email: config.super_admin.email,
+  role: USER_ROLES.SUPER_ADMIN,
+  password: config.super_admin.password,
+  verified: true,
+};
+
+export const seedSuperAdmin = async () => {
+  const isExistSuperAdmin = await User.findOne({
+    email: config.super_admin.email,
+    role: USER_ROLES.SUPER_ADMIN,
+  });
+  if (!isExistSuperAdmin) {
+    await User.create(payload);
+    logger.info('✨ Super Admin account has been successfully created!');
+  }
+};

src/app.ts

@@ -0,0 +1,51 @@
+import cors from 'cors';
+import express, { Request, Response } from 'express';
+import { StatusCodes } from 'http-status-codes';
+import globalErrorHandler from './app/middlewares/globalErrorHandler';
+import router from './routes';
+import { Morgan } from './shared/morgen';
+const app = express();
+
+//morgan
+app.use(Morgan.successHandler);
+app.use(Morgan.errorHandler);
+
+//body parser
+app.use(cors());
+app.use(express.json());
+app.use(express.urlencoded({ extended: true }));
+
+//file retrieve
+app.use(express.static('uploads'));
+
+//router
+app.use('/api/v1', router);
+
+//live response
+app.get('/', (req: Request, res: Response) => {
+  const date = new Date(Date.now());
+  res.send(
+    `<h1 style="text-align:center; color:#173616; font-family:Verdana;">Beep-beep! The server is alive and kicking.</h1>
+    <p style="text-align:center; color:#173616; font-family:Verdana;">${date}</p>
+    `
+  );
+});
+
+//global error handle
+app.use(globalErrorHandler);
+
+//handle not found route;
+app.use((req, res) => {
+  res.status(StatusCodes.NOT_FOUND).json({
+    success: false,
+    message: 'Not found',
+    errorMessages: [
+      {
+        path: req.originalUrl,
+        message: "API DOESN'T EXIST",
+      },
+    ],
+  });
+});
+
+export default app;

src/app/builder/QueryBuilder.ts

@@ -0,0 +1,97 @@
+import { FilterQuery, Query } from 'mongoose';
+
+class QueryBuilder<T> {
+  public modelQuery: Query<T[], T>;
+  public query: Record<string, unknown>;
+
+  constructor(modelQuery: Query<T[], T>, query: Record<string, unknown>) {
+    this.modelQuery = modelQuery;
+    this.query = query;
+  }
+
+  //searching
+  search(searchableFields: string[]) {
+    if (this?.query?.searchTerm) {
+      this.modelQuery = this.modelQuery.find({
+        $or: searchableFields.map(
+          field =>
+            ({
+              [field]: {
+                $regex: this.query.searchTerm,
+                $options: 'i',
+              },
+            } as FilterQuery<T>)
+        ),
+      });
+    }
+    return this;
+  }
+
+  //filtering
+  filter() {
+    const queryObj = { ...this.query };
+    const excludeFields = ['searchTerm', 'sort', 'page', 'limit', 'fields'];
+    excludeFields.forEach(el => delete queryObj[el]);
+
+    this.modelQuery = this.modelQuery.find(queryObj as FilterQuery<T>);
+    return this;
+  }
+
+  //sorting
+  sort() {
+    let sort = (this?.query?.sort as string) || '-createdAt';
+    this.modelQuery = this.modelQuery.sort(sort);
+
+    return this;
+  }
+
+  //pagination
+  paginate() {
+    let limit = Number(this?.query?.limit) || 10;
+    let page = Number(this?.query?.page) || 1;
+    let skip = (page - 1) * limit;
+
+    this.modelQuery = this.modelQuery.skip(skip).limit(limit);
+
+    return this;
+  }
+
+  //fields filtering
+  fields() {
+    let fields =
+      (this?.query?.fields as string)?.split(',').join(' ') || '-__v';
+    this.modelQuery = this.modelQuery.select(fields);
+
+    return this;
+  }
+
+  //populating
+  populate(populateFields: string[], selectFields: Record<string, unknown>) {
+    this.modelQuery = this.modelQuery.populate(
+      populateFields.map(field => ({
+        path: field,
+        select: selectFields[field],
+      }))
+    );
+    return this;
+  }
+
+  //pagination information
+  async getPaginationInfo() {
+    const total = await this.modelQuery.model.countDocuments(
+      this.modelQuery.getFilter()
+    );
+    const limit = Number(this?.query?.limit) || 10;
+    const page = Number(this?.query?.page) || 1;
+    const totalPage = Math.ceil(total / limit);
+
+    return {
+      total,
+      limit,
+      page,
+      totalPage,
+    };
+  }
+}
+
+export default QueryBuilder;