https://github.com/x-nimesh/bulk-email-processor-be

https://github.com/x-nimesh/bulk-email-processor-be

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/x-nimesh/bulk-email-processor-be
• Owner: X-nimesh
• Created: 2024-07-11T13:32:06.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-12T11:53:45.000Z (6 months ago)
• Last Synced: 2024-08-03T17:32:04.136Z (5 months ago)
• Language: TypeScript
• Size: 186 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Backend Application for Bulk Email Processor

## Overview

This repository contains the backend application for the project. It provides API endpoints that the frontend application interacts with.

Link to Frontend Repo.-> **[Frontend Repo](https://github.com/X-nimesh/bulk-email-processor-FE)**

## Prerequisites

- Docker

- Docker Compose

## Setup and Running

1. **Clone the Repository**

   ```bash

   git clone https://github.com/X-nimesh/bulk-email-processor-ekbana.git

   cd 

   ```

2. **Clone the Repository**

   Create a .env file in the root of your backend directory and add the following configuration:

   ```bash

    MAILER_HOST=live.smtp.mailtrap.io

    MAILER_PORT=587

    MAILER_USER=api

    PASSWORD=

   ```

   other env are already setup in the docker-compose.yml file

3. **Clone the Repository**

   Use Docker Compose to build and start the backend application along with PostgreSQL and RabbitMQ:

   ```bash

   docker-compose up -d --build

   ```

4. **Access backend and swagger docs**

   ```bash

   The backend service will be available internally to other containers at http://localhost:3000 .

   ```

   For local testing or integration, here is the link of swagger docs -> http://localhost:3000/docs

   Database can be accessed at **http://localhost:5432**

   Rabbitmq can be accessed at **http://localhost:15672**

5. **Stopping the Backend**

   To stop the backend container and related services, run:

   ```bash

   docker-compose down

   ```