Node.js Backend Architecture TypeScript

The project implements a custom architecture called 3RE, designed for maintainability and testability. The architecture consists of four primary layers for handling requests:

1. Router: Handles incoming request routing.
2. RouteHandler: Contains the logic for specific routes.
3. ResponseHandler: Manages the standardized API response format.
4. ErrorHandler: Provides centralized error handling across the application.

To run the project without Docker, you must have Node.js and npm installed.

1. Configure host settings in .env and .env.test:
   • DB_HOST=localhost
   • REDIS_HOST=localhost
2. Install dependencies:

   npm install

3. Run the application:
   • Production mode: npm start
   • Watch mode (for development): npm run watch
4. Run tests:

   npm test

To stop the application and tester containers if previously running via Docker:

docker compose stop tester
docker compose stop app

# From the root of the project executes
$ npm install

# production mode
$ npm start

# watch mode
$ npm run watch

# unit and integration tests
$ npm test

The project requires RSA keys for cryptographic operations. You must place two files in the keys/ directory:

1. private.pem: The private key.
2. public.pem: The public key.

You can generate these keys using online tools or local command-line utilities. Example files are provided in the keys/ directory for reference.

Retrieve the authenticated user's profile information using the GET /profile/my endpoint. This request requires an x-api-key and a Bearer token in the Authorization header (obtained from a previous signup or login).

GET /profile/my HTTP/1.1
Host: localhost:3000
x-api-key: GCMUDiuY5a7WvyUNt9n3QztToSHzK7Uj
Content-Type: application/json
Authorization: Bearer <your_token_received_from_signup_or_login>

Register a new user using the POST /signup/basic endpoint. This requires an x-api-key in the headers and a JSON body containing user details. A successful signup returns a 200 status code with the user object and authentication tokens.

POST /signup/basic HTTP/1.1
Host: localhost:3000
x-api-key: GCMUDiuY5a7WvyUNt9n3QztToSHzK7Uj
Content-Type: application/json

{
    "name" : "Janishar Ali",
    "email": "ali@github.com",
    "password": "changeit",
    "profilePicUrl": "https://avatars1.githubusercontent.com/u/11065002?s=460&u=1e8e42bda7e6f579a2b216767b2ed986619bbf78&v=4"
}

To ensure data persistence and automatic database setup, the MongoDB service uses the following configurations:

1. Initialization: The file ./addons/init-mongo.js is mounted to /docker-entrypoint-initdb.d/init-mongo.js inside the container. This script runs upon the first creation of the container.
2. Persistence: A named volume dbdata is used to store data in /data/db, ensuring data survives container removal.

mongo:
  image: mongo:8.3.2
  volumes:
    - ./addons/init-mongo.js:/docker-entrypoint-initdb.d/init-mongo.js:ro
    - dbdata:/data/db

volumes:
  dbdata:

The project follows a modular structure organized by feature and layer:

• src/auth: Authentication and authorization logic.
• src/cache: Redis-based caching implementation.
• src/core: Core utilities including ApiError, ApiResponse, JWT, and Logger.
• src/database/model: Mongoose models (e.g., User, Blog, Role).
• src/database/repository: Data access layer (Repositories) for interacting with models.
• src/helpers: Shared utilities like asyncHandler, validator, and permission helpers.
• src/routes: API route definitions grouped by feature (e.g., access, blog, blogs, profile).
• tests: Comprehensive unit and integration tests mirroring the src structure.

├── src
│   ├── auth
│   ├── core
│   ├── cache
│   ├── database
│   │   ├── model
│   │   └── repository
│   ├── helpers
│   ├── routes
│   └── types
├── tests

Details for the GET /profile/my endpoint.

Success Response (200): Returns statusCode: "10000", a success message, and a data object containing the user's name, profilePicUrl, and an array of roles (each containing an _id and a code).

{
  "statusCode": "10000",
  "message": "success",
  "data": {
    "name": "Janishar Ali Anwar",
    "profilePicUrl": "https://avatars1.githubusercontent.com/u/11065002?s=460&u=1e8e42bda7e6f579a2b216767b2ed986619bbf78&v=4",
    "roles": [
      {
        "_id": "5e7b8acad7aded2407e078d7",
        "code": "LEARNER"
      },
      {
        "_id": "5e7b8c22d347fc2407c564a6",
        "code": "WRITER"
      },
      {
        "_id": "5e7b8c2ad347fc2407c564a7",
        "code": "EDITOR"
      }
    ]
  }
}