Skip to content

README.md

Latest commit

 

History

History
58 lines (44 loc) · 1.57 KB

README.md

File metadata and controls

58 lines (44 loc) · 1.57 KB
Raw

🌊 NestWave

NestJS TypeScript MongoDB Firebase License CI

A scalable NestJS backend for an interest-based social app — secure authentication, real-time notifications, media uploads, and internationalization.

🔗 Live API: https://circle-s.onrender.com/apis

✨ Features

  • 🔐 JWT authentication & authorization
  • 🔔 Real-time push notifications (Firebase Cloud Messaging)
  • 📤 Media uploads (Multer)
  • ✉️ Transactional email (Nodemailer)
  • 🌍 Internationalization (i18n)
  • ✅ Request validation (Joi)
  • 📜 Swagger API documentation

🧰 Tech Stack

Area Tech
Framework NestJS
Language TypeScript
Database MongoDB (Mongoose)
Auth JWT
Notifications Firebase Cloud Messaging
Email Nodemailer
Validation Joi
Docs Swagger
Testing Jest
Deploy Docker

🚀 Getting Started

npm install
cp .env.example .env     # set Mongo URI, JWT secret, Firebase & mail credentials
npm run start:dev

Swagger UI: /api · Live demo: https://circle-s.onrender.com/apis

🧪 Testing

npm test
npm run test:e2e

📄 License

MIT