notification-microservice

A scalable notification microservice developed with TypeScript, Node.js. For sending E-Mail/SMS.

Project Structure

src/
├── Infra/        # Database implementation and external communication
├── Application/  # Application logic and use cases
├── Domain/       # Entities and domain rules
├── Shared/       # Utility Shared functions and helpers

Installation

1. Clone the repository:

git clone https://github.com/username/notification-microservice.git
cd notification-microservice

1. Setup Husky:

npm run prepare

2. Install dependencies:

npm install

3. Set up the database with Docker Compose:

docker-compose up --build

Run the Service

Start the microservice:

npm run start:dev

The service will be available at http://localhost:3000.

Docker Commands

• To stop and remove the containers:

docker-compose down

Contributing

1. Fork the repository.
2. Create a branch for your feature (git checkout -b feature/feature-name).
3. Commit your changes (git commit -am 'Add new feature').
4. Push the branch (git push origin feature/feature-name).
5. Create a Pull Request.

License

Licensed under the MIT License.