vithorluc / notification-backend Goto Github PK

This project provides a notification service built with Node.js, TypeScript, TypeORM, and Express. It allows you to send notifications and log them into a database. Additionally, it provides endpoints to retrieve the logs and check the service health.

1. Features
2. Database Schema
3. API Endpoints
4. Getting Started
5. Running the Project

• Send Notifications: Send notifications with different categories and types.
• Log Notifications: Log all notifications into the database.
• Retrieve Logs: Retrieve logs of all notifications, sorted from newest to oldest.
• Health Check: Check the health status of the service.

The database consists of the following tables:

Send a notification and log it into the database.

Payload:

{
  "message": "Test Message",
  "category_id": "1",
  "notification_type_id": "1"
}

Retrieve the logs of all notifications, sorted from newest to oldest.

Response:

[
  {
    "id": 2,
    "message": "Test Message",
    "timestamp": "2024-06-06T18:22:11.000Z",
    "user": null,
    "category": {
      "id": 1,
      "name": "Sports"
    },
    "notificationType": {
      "id": 1,
      "name": "SMS"
    }
  },
  {
    "id": 1,
    "message": "Test Message",
    "timestamp": "2024-06-06T18:17:26.000Z",
    "user": null,
    "category": {
      "id": 1,
      "name": "Sports"
    },
    "notificationType": {
      "id": 1,
      "name": "SMS"
    }
  }
]

Check the health status of the service.

Response:

OK

Follow these steps to get the project up and running:

1. Clone the repository:

   git clone <repository_url>
   cd <repository_directory>

2. Install dependencies:

   npm install

3. Create environment variables file: Create a .env file in the root directory with the following content:

   DB_HOST=localhost
   DB_PORT=5432
   DB_USERNAME=user
   DB_PASSWORD=password
   DB_DATABASE=notifications
   REDIS_URL=redis://localhost:6379

1. Start Docker containers: Make sure Docker is installed and running on your machine, then start the services with Docker Compose.

   docker compose up

2. Run the application:

   npm start

The application should now be running and accessible at http://localhost:3000.

Sending a Notification:

curl -X POST http://localhost:3000/api/send-notifications \
-H "Content-Type: application/json" \
-d '{
    "message": "Test Message",
    "category_id": "1",
    "notification_type_id": "1"
}'

Retrieving Notification Logs:

curl http://localhost:3000/api/notification-logs

Health Check:

curl http://localhost:3000/api/health-check