Integral Module for Managing All User-Related Operations

This module is an integral part of an application, responsible for managing all user-related operations. It provides APIs for creating, updating, deleting, and retrieving user information.

Prerequisites

• Node.js
• Docker

Quick Start

# Clone the app
$ git clone https://github.com/LuccaRebelloToledo/integral-module-users.git

# Install dependencies
$ npm install

# Build the project
$ npm run build

# Fill in the environment variables in a .env file
# Refer to .env.example for the required variables

# Run docker-compose
$ docker-compose up -d

# Start the server
$ npm start

# View the website at: http://localhost:4000/api-docs/

Running Tests

To run the test suite, first install the dependencies, then run npm test:

$ npm install
$ npm test

API Documentation

Refer to the API Documentation for more details on how to use the APIs.

Contributing

Contributions are always welcome. If you find any issues or have any suggestions, feel free to open an issue or submit a pull request.