🛍️ Digital E-Commerce Backend

Enterprise-grade REST API for modern e-commerce platforms

Features • Quick Start • Documentation • API Reference • Contributing

📖 Overview

Digital E-Commerce Backend is a production-ready, scalable, and secure REST API built with Node.js, Express, and MongoDB. It provides comprehensive features for user management, payment processing, digital wallets, and multi-language support.

🎯 Key Capabilities

🔐 JWT Authentication with refresh token rotation
💰 PayOS Payment Integration with webhook support
💳 Digital Wallet System with atomic transactions
🌍 i18n Support (English, Vietnamese)
🛡️ Enterprise Security (rate limiting, input validation, CORS, Helmet)
📧 Email Notifications with template system
🏗️ Clean Architecture (Repository pattern, service layer)
🧪 Test Coverage (unit, integration, e2e)

✨ Features

Authentication & Authorization

User registration with email verification
JWT-based authentication (access + refresh tokens)
Role-based access control (User, Staff, Manager, Admin)
Password reset with secure tokens
Session management

Payment & Wallet

PayOS payment gateway integration
Digital wallet with real-time balance
Transaction history with audit trail
Webhook processing for payment updates
Multi-currency support (VND default)

User Management

Profile management with avatar upload
Email verification workflow
Password change and recovery
User preferences and settings
Activity tracking

Communication

Transactional emails (Nodemailer)
Template-based email system
Multi-language email support
Background job processing

Security

Rate limiting (100 req/15min per IP)
Input validation and sanitization
XSS and SQL injection protection
CORS configuration
Secure HTTP headers (Helmet)
Environment-based configuration

🚀 Quick Start

Prerequisites

Tool	Version	Purpose
Node.js	≥ 14.0.0	Runtime
npm/yarn	Latest	Package manager
MongoDB	≥ 4.4	Database
Redis	≥ 6.0	Cache & queues (optional)

Installation

# 1. Clone the repository
git clone https://github.com/devnguyen0111/Digital-Ecommerce-BE.git
cd Digital-Ecommerce-BE

# 2. Install dependencies
npm install

# 3. Configure environment
cp .env.example .env
# Edit .env with your configuration

# 4. Start MongoDB
# Windows: net start MongoDB
# macOS/Linux: mongod

# 5. Start the server
npm run dev # Development with hot reload
npm start   # Production

Verify Installation

# Health check
curl http://localhost:5000/health

# Expected response:
# {
#   "status": "healthy",
#   "timestamp": "2026-02-07T10:30:00.000Z",
#   "uptime": 125
# }

📚 Documentation

Document	Description
Architecture	System design and patterns
Codebase Overview	Code organization
API Reference	Complete API documentation
Environment Setup	Configuration guide
Coding Conventions	Code standards
Contributing	Contribution guidelines
Deployment	Production deployment
Folder Structure	Directory organization
Changelog	Version history

🏗️ Architecture

System Overview

graph TB
    Client[Client Apps]
    API[Express Server]
    Auth[Auth Middleware]
    Routes[Routes Layer]
    Controllers[Controllers]
    Services[Services]
    Repos[Repositories]
    DB[(MongoDB)]
    Redis[(Redis)]
    PayOS[PayOS API]
    Email[Email Service]

    Client -->|HTTPS| API
    API --> Auth
    Auth --> Routes
    Routes --> Controllers
    Controllers --> Services
    Services --> Repos
    Repos --> DB
    Services --> Redis
    Services --> PayOS
    Services --> Email

Layer Responsibilities

Layer	Purpose	Location
Routes	API endpoint definition	`src/routes/`
Middleware	Auth, validation, logging	`src/middleware/`
Controllers	Request/response handling	`src/controllers/`
Services	Business logic	`src/services/`
Repositories	Data access abstraction	`src/repositories/`
Models	Database schemas	`src/models/`
Utils	Helper functions	`src/utils/`

🔌 API Reference

Base URL

Development: http://localhost:5000
Production: https://your-domain.com

Authentication

Include JWT token in requests:

Authorization: Bearer <your_jwt_token>

Example: User Registration

Request:

POST /api/auth/register
Content-Type: application/json

{
  "username": "johndoe",
  "email": "john@example.com",
  "password": "SecurePass123!",
  "preferredLanguage": "en"
}

Response:

{
  "success": true,
  "message": "User registered successfully",
  "data": {
    "user": {
      "id": "507f1f77bcf86cd799439011",
      "username": "johndoe",
      "email": "john@example.com"
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}

Endpoints Overview

Category	Endpoint	Method	Auth
Health	`/health`	GET	❌
Auth	`/api/auth/register`	POST	❌
Auth	`/api/auth/login`	POST	❌
Auth	`/api/auth/me`	GET	✅
User	`/api/users/profile`	GET	✅
Wallet	`/api/wallet`	GET	✅
Wallet	`/api/wallet/add-funds`	POST	✅

📖 Full API Documentation: API_REFERENCE.md

🛡️ Security

Implemented Measures

✅ JWT with refresh token rotation
✅ bcrypt password hashing (10 rounds)
✅ Rate limiting (100 req/15min)
✅ Input validation (express-validator)
✅ CORS with origin whitelist
✅ Helmet for secure HTTP headers
✅ Environment variable protection
✅ SQL injection prevention (Mongoose)
✅ XSS protection

Security Best Practices

Never commit .env files
Use strong JWT secrets (32+ chars)
Rotate secrets regularly
Enable HTTPS in production
Keep dependencies updated
Run security audits: npm audit

🧪 Testing

# Run all tests
npm test

# Run with coverage
npm run test:coverage

# Run specific test suite
npm test -- auth.test.js

# Watch mode
npm test -- --watch

🤝 Contributing

We welcome contributions! Please read our Contributing Guide.

Quick Contribution Steps

Fork the repository
Create a feature branch: git checkout -b feature/amazing-feature
Commit changes: git commit -m 'feat: add amazing feature'
Push to branch: git push origin feature/amazing-feature
Open a Pull Request

Commit Convention

We follow Conventional Commits:

feat: add new feature
fix: fix bug
docs: update documentation
style: format code
refactor: restructure code
test: add tests
chore: maintenance tasks

📄 License

This project is licensed under the ISC License.

Copyright (c) 2026 devnguyen0111

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

🗺️ Roadmap

v0.3.0 (Q2 2026)

v0.4.0 (Q3 2026)

v0.5.0 (Q4 2026)

🙏 Acknowledgments

Built with amazing open-source technologies:

Express.js - Web framework
MongoDB - Database
Mongoose - ODM
JWT - Authentication
Nodemailer - Email
PayOS - Payment gateway

📞 Support

📖 Documentation: /docs
🐛 Issues: GitHub Issues
💬 Discussions: GitHub Discussions

Connect

devnguyen0111

GitHub: @devnguyen0111
Repository: Digital-Ecommerce-BE

Made with ❤️ by devnguyen0111

⭐ Star this repo if you find it helpful!

Back to Top

Name		Name	Last commit message	Last commit date
.github		.github
docs		docs
locales		locales
src		src
.editorconfig		.editorconfig
.env.example		.env.example
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.prettierrc		.prettierrc
Dockerfile		Dockerfile
README.md		README.md
README.old.md		README.old.md
api-endpoints.json		api-endpoints.json
docker-compose.yml		docker-compose.yml
ecosystem.config.js		ecosystem.config.js
package.json		package.json
server.js		server.js
test-webhook.js		test-webhook.js

Latest commit

History

Folders and files

Repository files navigation