ketantotlani/payever

Description

REST Application

This is a simple REST application built with NestJS framework. It communicates with the ReqRes API, stores user data in MongoDB, sends emails, and emits RabbitMQ events.

Prerequisites

Make sure you have the following installed on your machine:

• Node.js
• MongoDB
• RabbitMQ

Installation

1. UnZip the repository:

Installation

$ npm install

Running the app

Configure the application:

Modify the values inside the file to match your environment. This file contains configuration for MongoDB and RabbitMQ connection.

Running the Application

1. Start RabbitMQ service on your machine, Meanwhile there is no connection changes needed for MongoDB since an online repo is already connected.

2. Build and start the application:

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

The application should now be running on http://localhost:4000.

API Endpoints

• POST /api/users: Create a user entry in the database. This will trigger sending a dummy email and RabbitMQ event.

• GET /api/user/{userId}: Retrieve user data from ReqRes API and return it in JSON representation.

• GET /api/user/{userId}/avatar: Retrieve the user's avatar image. On the first request, the image will be saved as a plain file in the file system and stored in the MongoDB. On subsequent requests, the previously saved image will be returned in base64-encoded representation.

• DELETE /api/user/{userId}/avatar: Removes the user's avatar image from the file system and delete the corresponding entry from the MongoDB.

Testing

To run the tests, use the following command:

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

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.

Stay in touch

• Author - Ketan Totlani

License

Nest is MIT licensed.

payever