Create Node Backend

A CLI tool to generate a professional Node.js backend with Express, supporting MongoDB or PostgreSQL, with a pre-configured folder structure, CORS, dotenv, authentication, and optional logging.

Installation

Install the package globally to use the CLI command:

npx create-node-dev

The CLI will prompt you for the following:

• Project name: The name of the project folder (default: node-backend).
• Use src folder: Whether to organize code in a src folder (y/N).
• Main file name: The main server file (default: index.js).
• Database: Choose between MongoDB or PostgreSQL (default: MongoDB).
• Include logging (winston): Whether to include logging with winston (y/N).

Environment Variables

The .env file includes:

# Server Configuration
NODE_ENV=development
PORT=3000

# JWT Secret
JWT_SECRET=your-super-secret-jwt-key-change-this-in-production

# Logging (if enabled)
LOG_LEVEL=info

# Database Configuration (example for MongoDB)
MONGODB_URI=mongodb://localhost:27017/your-project-name

# OR (example for PostgreSQL)
DB_NAME=your-project-name
DB_USER=postgres
DB_PASSWORD=password
DB_HOST=localhost
DB_PORT=5432

Update these with your actual database credentials.

Scripts

• npm start: Run the server in production mode.
• npm run dev: Run the server with nodemon for development.
• npm test: Run tests with jest.
• npm run lint: Lint code with eslint.
• npm run format: Format code with prettier.

API Documentation

Base URL: http://localhost:3000/api

Authentication: Most endpoints require a JWT token in the Authorization header: Bearer <token>.

Authentication Endpoints

POST /auth/register

Register a new user.

Body:

{
  "name": "string",
  "email": "string",
  "password": "string"
}

Responses:

• 201: { success: true, message: "User registered successfully", token: "string", user: { id, name, email } }
• 400: { success: false, message: "string" }
• 500: { success: false, message: "Server error" }

POST /auth/login

Log in a user.

Body:

{
  "email": "string",
  "password": "string"
}

Responses:

• 200: { success: true, message: "Login successful", token: "string", user: { id, name, email } }
• 400: { success: false, message: "Invalid credentials" }
• 500: { success: false, message: "Server error" }

GET /auth/profile

Get authenticated user's profile.

Headers: Authorization: Bearer <token>

Responses:

• 200: { success: true, user: { id, name, email } }
• 401: { success: false, message: "No token, authorization denied" }
• 404: { success: false, message: "User not found" }
• 500: { success: false, message: "Server error" }

User Management Endpoints

GET /users

List all users.

Headers: Authorization: Bearer <token>

Responses:

• 200: { success: true, count: number, data: [{ id, name, email, role, isActive, createdAt, updatedAt }] }
• 401: { success: false, message: "No token, authorization denied" }
• 500: { success: false, message: "Server error" }

GET /users/:id

Get a user by ID.

Headers: Authorization: Bearer <token>

Responses:

• 200: { success: true, data: { id, name, email, role, isActive, createdAt, updatedAt } }
• 401: { success: false, message: "No token, authorization denied" }
• 404: { success: false, message: "User not found" }
• 500: { success: false, message: "Server error" }

PUT /users/:id

Update a user.

Headers: Authorization: Bearer <token>

Body:

{
  "name": "string",
  "email": "string",
  "role": "string"
}

Responses:

• 200: { success: true, message: "User updated successfully", data: { id, name, email, role, isActive, updatedAt } }
• 401: { success: false, message: "No token, authorization denied" }
• 404: { success: false, message: "User not found" }
• 500: { success: false, message: "Server error" }

DELETE /users/:id

Delete a user.

Headers: Authorization: Bearer <token>

Responses:

• 200: { success: true, message: "User deleted successfully" }
• 401: { success: false, message: "No token, authorization denied" }
• 404: { success: false, message: "User not found" }
• 500: { success: false, message: "Server error" }

License

MIT