softenrj/terraSync-backend

🚀 Express TypeScript Boilerplate

🛠️ Production-ready Node.js + Express + TypeScript boilerplate with enterprise-grade features

⚡ Zero-config setup | 🛡️ Security-first | 📊 Fully tested | 🎯 Type-safe

---

✨ What's Inside

Feature	Description	Status
🎯 TypeScript 5.9	Latest TypeScript with strict mode	✅
🛡️ Security Suite	Helmet, CORS, Rate Limiting	✅
📊 Testing	Vitest + Supertest + Coverage	✅
📝 API Documentation	Swagger/OpenAPI 3.0	✅
🎨 Code Quality	ESLint + Prettier + Husky	✅

| 🚀 Dev Experience | Hot reload, linting, formatting | ✅ | | 📦 Production Ready | Build optimization, error handling | ✅ |

---

A production-ready Node.js + Express + TypeScript boilerplate, Generated using create-rjx ⚡

📁 Project Structure

src/
├── 📄 app.ts              # Express app configuration
├── 📄 server.ts           # Server entry point
├── 📁 config/             # Configuration modules
│   ├── corsConfig.ts      # CORS configuration
│   ├── env.ts            # Environment variables
│   ├── halmetConfig.ts    # Security headers
│   ├── loggerConfig.ts    # Winston logger setup
│   └── rateLimitConfig.ts # Rate limiting
├── 📁 docs/               # API documentation
│   └── swagger.yaml      # OpenAPI 3.0 spec
├── 📁 middleware/        # Custom middleware
│   └── errorHandler.ts   # Global error handler
├── 📁 tests/             # Test suites
│   └── health.test.ts    # Health check tests
└── 📄 router.ts          # Route definitions

---

🛠️ Available Scripts

Script	Description	Command
dev	Start development server	npm run dev
dev:hot	Hot reload + linting	npm run dev:hot
build	Build for production	npm run build
start	Start production server	npm start
test	Run tests	npm test
test:watch	Watch mode testing	npm run test:watch
coverage	Generate coverage report	npm run coverage
lint	Lint code	npm run lint
clean	Clean build artifacts	npm run clean

---

🎯 API Documentation

📊 Swagger UI

Access interactive API documentation at: http://localhost:3000/docs

🔍 Health Check Endpoint

GET /health

Response:

{
  "status": "ok",
  "uptime": 12.345,
  "timestamp": 1690000000000
}

---

🛡️ Security Features

🔒 Helmet

• Content Security Policy (CSP)
• X-Frame-Options
• X-Content-Type-Options
• And more security headers

🌐 CORS

• Configurable CORS policies
• Environment-based settings

⚡ Rate Limiting

• Global rate limiting
• Configurable per environment
• IP-based tracking

---

🧪 Testing Strategy

✅ Test Coverage

• Unit Tests: Vitest for fast execution
• Integration Tests: Supertest for API testing
• Coverage Reports: Built-in coverage analysis

🎯 Test Commands

# Run all tests
npm test

# Watch mode
npm run test:watch

# Coverage report
npm run coverage

🌍 Environment Configuration

Environment Files

.env.dev     # Development environment
.env.prod    # Production environment
.env.test    # Test environment

Environment Variables

# Server
PORT=3000
NODE_ENV=development

# # Database
# MONGODB_URI=mongodb://localhost:27017/myapp

# # Security
# RATE_LIMIT_WINDOW=15
# RATE_LIMIT_MAX=100

---

🎨 Code Quality Tools

ESLint Configuration

• TypeScript-specific rules
• Import sorting
• Unused imports detection
• Prettier integration

Prettier Setup

• Consistent code formatting
• TypeScript/JavaScript support
• JSON/CSS/Markdown formatting

Git Hooks

• Pre-commit linting
• Pre-commit formatting
• Commit message validation

---

🚀 Deployment

Build for Production

npm run build
npm start

---

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

---

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

👨‍💻 Author

Raj (Softenrj)

---

⭐ Star this repo if you found it helpful!