User Service

User microservice to Create, Read, Update and Delete Users.

---

---

---

---

---

Table of contents

• Usage documentation
  • Envs
  • Usage with Docker
    • Prerequisites
    • Usage
  • Usage with Node.JS
    • Prerequisites
    • Installation
    • Usage
    • Tests
  • Endpoints Rules
  • Postman Collection
• Architecture documentation
  • Database
  • Integrations
  • Folder Structure

---

Envs

You must configure .env file following the .env.example template. Some envs come directly from the AWS Parameter Store, so it is very important to have configured the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY values ​​so that all application envs are loaded correctly.

(Back to Table of contents ⬆️)

---

Docker Prerequisites

To run this project with docker, ensure that you have the following items:

• Docker
• Configured .env file

(Back to Table of contents ⬆️)

---

Docker Usage

Start the node server with the following commands:

docker compose build

docker compose up -d

(Back to Table of contents ⬆️)

---

Node Prerequisites

To run this project, ensure that you have the following items:

• Node.JS (v20.9.0)
• Configured .env file

(Back to Table of contents ⬆️)

---

Node Installation

1. Clone this repository to your local machine or download the source code.

2. Open a terminal and navigate to the project's root directory.

3. Run the following command to install the project dependencies:

   npm install

(Back to Table of contents ⬆️)

---

Node Usage

Start the node server in developer mode with the following command:

npm run start:dev

This will start the server and watch for any file changes, automatically restarting the server when necessary.

(Back to Table of contents ⬆️)

---

Tests

• Run the following command to execute the project tests:

  npm run test

(Back to Table of contents ⬆️)

---

Endpoints rules

• All endpoints can be found here.
• Except healthcheck, all endpoints have the prefix /api followed by the route version, for example /api/v1/.
• All endpoints require authorization, which can be passed through the Authorization header with a valid JWT token (this can be obtained by making a POST request on the login route with username and password).
• The Authorization header is an Bearer Token.

(Back to Table of contents ⬆️)

---

Postman

• Online Collection

• Download Collection

(Back to Table of contents ⬆️)

---

Database

(Back to Table of contents ⬆️)

---

Integrations

(Back to Table of contents ⬆️)

---

Folder Structure

• .vscode: vscode configs.
• docs: all project documentations, like scripts, diagrams, texts.
• src
  • config: generic project configurations, like database configs, commit configs.
    • .husky: project validations with husky.
    • database: database configs.
      • models: database models.
    • envs: local and async envs configs.
  • controllers: application controllers.
  • entities: application entities.
  • interfaces: application interfaces.
  • dtos: application dtos.
  • middlewares: application middlewares.
  • repositories: application repositories.
  • routes: application routes.
    • v1: v1 endpoints.
  • services: application services.
  • utils: common utils functions, constants, and application dependencies.
    • logger: logger module.
• tests: project tests.

(Back to Table of contents ⬆️)