feat(readme): Add README

Author: adrianmjim

README:md

@@ -0,0 +1,83 @@
+# NestJS API gRPC Example 
+
+<p align="center">
+  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
+</p>
+
+ 
+<p align="center">
+  <a href="https://github.com/Adrianmjim/nestjs-api-grpc-example/workflows/CI/badge.svg"><img src="https://github.com/Adrianmjim/nestjs-api-grpc-example/workflows/CI/badge.svg" /></a>
+  <a href="https://codecov.io/gh/Adrianmjim/nestjs-api-grpc-example" > 
+  <img src="https://codecov.io/gh/Adrianmjim/nestjs-api-grpc-example/graph/badge.svg?token=QZT9E52RPJ"/> 
+  </a>
+  <a href="https://codeclimate.com/github/Adrianmjim/nestjs-api-grpc-example/maintainability"><img src="https://api.codeclimate.com/v1/badges/001ca441a785966ce8be/maintainability" /></a>
+</p>
+
+## Description
+
+gRPC API pet project built on top of NestJS using DDD, CQRS, MikroORM and PostgreSQL
+
+## Requirements:
+
+1. Install [NodeJS](https://nodejs.org) and [pnpm](https://pnpm.io)
+
+2. Install dependencies
+
+```bash
+pnpm install
+```
+
+3. Add an .env file based on .env.example
+
+## Database
+
+We need a PostgreSQL instance to run the project. It's necessary to configure the environment variables for this database in the .env file. This project can also be launched with Docker Compose, which already includes the required database instance.
+
+This repository uses [MikroORM](https://mikro-orm.io) and its [migration system](https://mikro-orm.io/docs/migrations). To apply the migrations, you need to run the following command:
+
+```bash
+npx mikro-orm migration:up
+```
+
+## Usage:
+
+You can start the app in development mode:
+
+```bash
+pnpm start:dev
+```
+
+Or in production mode:
+
+1. First, You need to build code:
+
+```bash
+pnpm build
+```
+
+2. Then, You can start app:
+
+```bash
+pnpm start:prod
+```
+
+To run the current repository using Docker Compose, follow these steps:
+
+1. Build images
+
+```bash
+docker compose build
+```
+
+2. Run services
+
+```bash
+docker compose up
+```
+
+## Test
+
+You can run test of this project:
+```bash
+pnpm test
+```

docker-compose.yml

@@ -24,7 +24,6 @@ services:
     depends_on:
       - database
     ports:
-      - 5001:5000
-      - 3000:3000
+      - 5000:5000
       - 9228:9228
       - 9229:9229

package.json

@@ -17,18 +17,10 @@
     "start:dev": "TZ=$npm_package_config_TZ tsc-watch -p tsconfig.build.json --onSuccess \"node --inspect=0.0.0.0:9229 dist/main.js\"",
     "start:prod": "TZ=$npm_package_config_TZ node dist/main.js",
     "test": "TZ=$npm_package_config_TZ jest",
-    "test:ci": "npm run test -- --collectCoverage --ci --reporters=default --reporters=jest-junit --coverageReporters=cobertura --coverageReporters=text",
-    "test:ci:diff": "npm run test -- --collectCoverage --ci --reporters=default --reporters=jest-junit --coverageReporters=cobertura --coverageReporters=text --changedSince=origin/$MR_TARGET_BRANCH",
     "test:debug": "TZ=$npm_package_config_TZ node --inspect-brk node_modules/jest/bin/jest.js --runInBand",
     "test:coverage": "npm test -- --coverage",
     "test:main": "TZ=$npm_package_config_TZ jest --changedSince=origin/main",
     "test:previous": "TZ=$npm_package_config_TZ jest --changedSince=HEAD~1",
-    "test:js:ci": "npm run test:js -- --ci",
-    "test:js:ci:coverage": "npm run test:js:ci -- --coverage",
-    "test:js:coverage": "npm run test:js -- --coverage",
-    "test:js": "npm test -- --config=jest.js.config.json",
-    "test:unit": "TZ=$npm_package_config_TZ jest --selectProjects Unit",
-    "test:unit:js": "npm run test:js -- --selectProjects Unit",
     "prepare": "node -e \"try { require('husky').install() } catch (e) {if (e.code !== 'MODULE_NOT_FOUND') throw e}\"",
     "mikro-orm:migration:create": "npx mikro-orm migration:create"
   },