feat: add project description

Author: sourcecode71

README.md

@@ -1,98 +1,94 @@
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
-</p>
+# NotifyLog
 
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
+![Build Status](https://img.shields.io/github/workflow/status/your-username/NotifyLog/CI/main)
+![License](https://img.shields.io/github/license/your-username/NotifyLog)
+![GitHub Stars](https://img.shields.io/github/stars/your-username/NotifyLog)
 
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
-<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
-<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
-<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
-<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
-  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
-    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
-  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+**NotifyLog** is a full-stack Node.js/NestJS microservice for sending email/SMS notifications, logging messages/errors, and managing webhooks, paired with a Next.js/React frontend to visualize notification and error log history. Features an interactive **Swagger UI** for API exploration.
 
-## Description
+## Table of Contents
+- [Features](#features)
+- [Tech Stack](#tech-stack)
+- [Getting Started](#getting-started)
+- [Frontend Setup](#frontend-setup)
+- [API Documentation](#api-documentation)
+- [Contributing](#contributing)
+- [License](#license)
 
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+## Features
+- Send notifications (email/SMS) with a strategy pattern.
+- Dual logging: Winston for info logs, MongoDB for error logs.
+- Webhook subscriptions for real-time event notifications.
+- Advanced log filtering and retrieval.
+- Next.js/React frontend for notification and error log history.
+- **Swagger UI** for interactive API documentation.
 
-## Project setup
+## Tech Stack
+- **Backend**: Node.js, NestJS, MongoDB, Mongoose, Winston, TypeScript
+- **Frontend**: Next.js, React, Tailwind CSS, React Query
+- **Tools**: Swagger UI, Prettier, ESLint
 
-```bash
-$ npm install
-```
+## Getting Started (Backend)
+### Prerequisites
+- Node.js (>=18.x)
+- MongoDB (local or Atlas)
+- Git
 
-## Compile and run the project
+### Installation
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/your-username/NotifyLog.git
+   cd NotifyLog
 
-```bash
-# development
-$ npm run start
 
-# watch mode
-$ npm run start:dev
+Install dependencies:npm install
 
-# production mode
-$ npm run start:prod
-```
 
-## Run tests
+Create .env:MONGO_URI=mongodb://localhost:27017/notifylog
 
-```bash
-# unit tests
-$ npm run test
 
-# e2e tests
-$ npm run test:e2e
+Start MongoDB:mongod
 
-# test coverage
-$ npm run test:cov
-```
 
-## Deployment
+Run the backend:npm run start
 
-When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
 
-If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
 
-```bash
-$ npm install -g @nestjs/mau
-$ mau deploy
-```
+Testing
 
-With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
+Access Swagger UI: http://localhost:3000/api
+Send notification:curl -X POST http://localhost:3000/api/notifications \
+-H 'Content-Type: application/json' \
+-d '{"recipient":"test@example.com","subject":"Test","body":"Message ID: MSG123.","mediaType":"EMAIL","notificationType":"message-id"}'
 
-## Resources
 
-Check out a few resources that may come in handy when working with NestJS:
+Get logs:curl http://localhost:3000/api/logs?level=error&context=NotificationController
 
-- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
-- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
-- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
-- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
-- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
-- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
-- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
-- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
 
-## Support
 
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+Frontend Setup
+Prerequisites
 
-## Stay in touch
+Node.js (>=18.x)
+Backend running at http://localhost:3000
 
-- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
+Installation
 
-## License
+Clone the frontend (or navigate to directory):git clone https://github.com/your-username/notifylog-frontend.git
+cd notifylog-frontend
 
-Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
+
+Install dependencies:npm install
+
+
+Run the frontend:npm run dev
+
+
+Access at http://localhost:3001.
+
+API Documentation
+Explore APIs interactively via Swagger UI at http://localhost:3000/api. Test endpoints like /api/notifications, /api/webhooks, and /api/logs with a user-friendly interface.
+Contributing
+Contributions are welcome! Check CONTRIBUTING.md for guidelines and issues for tasks (good first issue, hacktoberfest). Join our Discord.
+License
+MIT License. See LICENSE.```