ForexKing Backend API (Serverless)

🚀 Production-ready serverless API for Vercel deployment

Features

✅ Serverless Architecture - Optimized for Vercel deployment
✅ User Registration with OTP verification
✅ Email Service via Gmail SMTP
✅ Secure Authentication with bcrypt & JWT
✅ Contact Form with email notifications
✅ Rate Limiting & security features
✅ MongoDB Atlas cloud database
✅ Auto-scaling & high availability

---

🚀 Deploy to Vercel

GitHub Auto-Deploy

1. Push code to GitHub
2. Connect repository to Vercel
3. Configure environment variables
4. Deploy automatically

---

💻 Local Development

# 1. Install dependencies
npm install

# 2. Configure environment variables
# Create .env file with required variables

# 3. Start development server (Vercel Dev)
npm run dev

# Server will run on: http://localhost:3000

---

📊 API Endpoints

Base URL: https://apis.forexking.info

Health Check

Get API Status

GET /health

Response:

{
  "success": true,
  "message": "ForexKing Backend API is running",
  "timestamp": "2025-10-27T12:00:00.000Z",
  "environment": "production"
}

Authentication

1. Register New User

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

{
  "name": "John Doe",
  "email": "john@example.com",
  "password": "Strong@Pass123",
  "phone_number": "+201234567890"
}

Response:

{
  "success": true,
  "message": "Registration successful. Please check your email for OTP verification code.",
  "email": "john@example.com",
  "name": "John Doe"
}

2. Verify OTP

POST /api/verify-otp
Content-Type: application/json

{
  "email": "john@example.com",
  "otp": "123456"
}

Response:

{
  "id": "507f1f7***********",
  "name": "John Doe",
  "email": "john@example.com",
  "accessToken": "eyJhbGciOiJ*******..."
}

3. Login

POST /api/login
Content-Type: application/json

{
  "email": "john@example.com",
  "password": "Strong@Pass123"
}

Response:

{
  "id": "507f1f77b********",
  "name": "John Doe",
  "email": "john@example.com",
  "accessToken": "eyJhbGciOiJIUzI************..."
}

4. Resend OTP

POST /api/send-otp
Content-Type: application/json

{
  "email": "john@example.com"
}

Response:

{
  "success": true,
  "message": "OTP resent successfully. Please check your email."
}

Contact Form

Submit Contact Message

POST /api/contact
Content-Type: application/json

{
  "name": "Jane Smith",
  "email": "jane@example.com",
  "message": "I would like to know more about your services."
}

Response:

{
  "success": true,
  "message": "Message sent successfully. We will get back to you soon."
}

---

Validation Rules

Password Requirements

• Minimum 8 characters
• At least one uppercase letter (A-Z)
• At least one lowercase letter (a-z)
• At least one number (0-9)
• At least one special character (!@#$%^&*)

Email

• Valid email format
• Unique (not already registered)

Phone Number

• E.164 international format
• Must start with +
• Unique (not already registered)

Name

• 2-100 characters
• Required

---

📧 Email Templates

1. OTP Verification Email

Sent immediately after registration with 6-digit OTP code.
Expiry: 15 minutes

2. Welcome Email

Sent after successful account verification.

3. Contact Form Notification

Sent to company email when someone submits contact form.

---

⚙️ Environment Variables

Required environment variables must be configured in Vercel Dashboard:

Variable	Description
MONGODB_URI	MongoDB Atlas connection string
JWT_SECRET	Secret for JWT signing
JWT_EXPIRE	Token expiry duration
EMAIL_USER	Gmail email address
EMAIL_PASS	Gmail App Password
COMPANY_EMAIL	Email to receive contact forms
NODE_ENV	Environment mode

---

🔒 Security Features

• 🔐 bcrypt password hashing (10 rounds)
• 🎫 JWT token authentication
• 🛡️ Security headers (CORS, Content-Type)
• 🚦 Rate limiting per IP address
  • Register: 10 req / 15 min
  • Login: 10 req / 15 min
  • Contact: 5 req / 15 min
  • OTP Resend: 5 req / 15 min
• ✅ Input validation with custom validators
• ⏰ OTP expiration (15 minutes)
• 🌐 CORS enabled for all origins

---

📁 Project Structure (Serverless)

backend/
├── api/                      # Serverless functions
│   ├── _lib/                # Shared utilities
│   │   ├── serverless-helpers.js  # DB, CORS, validation
│   │   └── email-service.js       # Email functionality
│   ├── register.js          # POST /api/register
│   ├── login.js             # POST /api/login
│   ├── verify-otp.js        # POST /api/verify-otp
│   ├── send-otp.js          # POST /api/send-otp (resend)
│   ├── contact.js           # POST /api/contact
│   ├── health.js            # GET /health
│   └── index.js             # GET / (welcome)
├── models/
│   └── User.js              # User schema & methods
├── utils/
│   ├── generateToken.js     # JWT utilities
│   └── generateOTP.js       # OTP generation
├── templates/
│   ├── otpEmail.html        # OTP email template
│   ├── welcomeEmail.html    # Welcome email template
│   └── contactNotification.html # Contact notification
├── vercel.json              # Vercel configuration
├── package.json             # Dependencies
├── env.example              # Environment variables template
├── VERCEL_DEPLOYMENT.md     # Deployment guide
└── README.md                # This file

Legacy Files (kept for backward compatibility):

• server.js, routes/, controllers/, config/ - Traditional Express setup

---

Dependencies

{
  "express": "^4.18.2",
  "mongoose": "^8.0.0",
  "bcryptjs": "^2.4.3",
  "jsonwebtoken": "^9.0.2",
  "nodemailer": "^6.9.7",
  "dotenv": "^16.3.1",
  "cors": "^2.8.5",
  "express-validator": "^7.0.1",
  "helmet": "^7.1.0",
  "express-rate-limit": "^7.1.5"
}

---

📖 Documentation

For detailed deployment instructions and setup guides, contact the development team.

---

Error Handling

All errors return consistent JSON format:

{
  "success": false,
  "message": "Error description",
  "errors": ["Detailed errors if validation"]
}

Common HTTP Status Codes:

• 200 - Success
• 201 - Created (registration)
• 400 - Bad Request (validation error)
• 401 - Unauthorized (invalid credentials)
• 403 - Forbidden (account not verified)
• 404 - Not Found
• 429 - Too Many Requests (rate limit)
• 500 - Server Error

---

Testing

Use tools like:

• Postman - API testing GUI
• cURL - Command line
• Thunder Client - VS Code extension

Example test flow:

1. Register user → Receive OTP email
2. Verify OTP → Get access token
3. Login with credentials → Get access token
4. Use token for protected routes

---

🛠️ Development

# Install dependencies
npm install

# Run with Vercel dev server (recommended)
npm run dev

# Deploy to preview environment
npm run deploy:preview

# Deploy to production
npm run deploy

---

🌐 Production Deployment

Manual Deployment:

npm run deploy

---

License

Mustafagaberr © 2025