Payever Test

This project is created to test the Payever backend vacancy.

Getting Started

These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To run this project, you need to have Docker installed on your machine. If you don't have Docker installed, you can download and install it from the official website: Docker

Installing

To get started, follow these steps:

1. Clone this repository to your local machine:

   git clone https://github.com/IgorVVieira/payever-test.git

2. Change into the project directory:

   cd payever_test

3. Build and run the project using Docker Compose:

     docker-compose up -d

4. The project will now be running on your local machine.

Test in Postman

I left a file with the collection in the postman to facilitate the tests, available at: Collection

Running Unit Tests

To run the unit tests for this project, you can use the following command:

docker exec -it nestjs bash
yarn test

Running End-to-End (E2E) Tests

Observations: Unfortunately I had a problem running the e2e tests, the first time we had some errors, but when running the second time all the tests passed. Unfortunately I couldn't fix it in time, but I'm working on it. Sorry.
To run the end-to-end tests for this project, you can use the following command:
If you don't have the backend bash open, first run:

docker exec -it nestjs bash

After:

yarn test:e2e

Evidences

Observation: I had problems creating a mock fs to test avatar.service, I couldn't solve it for a while. I apologize for that.

Unit

E2E

Requirements

• The project passes ESLint checks.
• The project builds and starts successfully.
• All endpoints can be successfully requested using Postman.
• Data is stored in the database successfully, and RabbitMQ events are emitted.
• The application is well-covered with unit and functional tests.