The User Management API is a NestJS-based service designed for managing user avatars. It provides functionalities to interact with user avatars, including saving, retrieving, and deleting avatars, and fetching user details from an external API.
- Get Avatar from Database: Retrieve the user's avatar from MongoDB and return it in base64 format.
- Save Avatar to Database: Download an avatar image from a provided URL, save it to the filesystem, and store metadata in MongoDB.
- Delete Avatar: Remove the avatar image from the filesystem and delete its metadata from MongoDB.
- Fetch User by ID: Obtain user details from an external API.
- Node.js (>=14.x.x)
- MongoDB (>=4.x.x)
-
Clone the Repository:
git clone https://github.com/yourusername/your-repository.git cd your-repository -
Install Dependencies:
npm install
-
Configuration:
Create a
.envfile in the root directory of the project with the following content:MONGO_URI=mongodb+srv://<user>:<db_password>@<cluster>.<account>.mongodb.net/?retryWrites=true&w=majority&appName=Cluster0 RABBITMQ_URI=amqp://id.cloudamqp:5672 amqps://<user>:<db_password>@<cluster>.<account>.cloudamqp.com/<user> SMTP_EMAIL=[email protected] SMTP_PASSWORD=your-ethereal-password SMTP_HOST=smtp.ethereal.email SMTP_PORT=587
-
Run the Application:
npm run start
-
Run Tests:
To ensure everything is working correctly, run the tests:
npm test
To deploy the application using Docker, create a Docker image and run the container using the included Dockerfile.
You can deploy the application using various cloud services:
Google Cloud Run allows you to deploy and manage containerized applications. Follow the Google Cloud Run documentation for details on deployment.
If you prefer to avoid using containers, you can deploy the application on AWS Lambda. Utilize AWS SAM or the Serverless Framework (SLS) for this purpose. For guidance on deploying with AWS Lambda, refer to the AWS SAM documentation or the Serverless Framework documentation.
API documentation is available in the open-api.json file located in the root directory of the project. This file describes the API endpoints, request and response formats, and other details.
Here are some screenshots demonstrating the working functionality of SMTP , RabbitMQ and MongoDB:
For any questions or feedback, please contact [email protected].