Skip to content

About

Esta API foi criada para simplificar e otimizar o gerenciamento de membros, departamentos e congregações de uma igreja.

Resources

Stars

2 stars

Watchers

1 watching

Forks

Latest commit

 

History

86 Commits

Folders and files

Repository files navigation

API CAD ASSEMBLIES MIT license

NodeJS TypeScript Nest RabbitMQ AWS MongoDB Swagger

Esta API foi criada para simplificar e otimizar o gerenciamento de membros, departamentos e congregações de uma igreja. Ela permite agilizar processos como ativação e inativação de membros, transferência entre congregações, alterações de departamentos e a gestão do histórico de posições ocupadas por cada membro.

Estrutura do Projeto

A aplicação é dividida nos seguintes microsserviços:

  1. API Gateway
    • Centraliza as requisições HTTP e as distribui para os microsserviços
    • Gerencia autenticação e autorização
    • Realiza validação inicial dos dados
  2. Auth
    • Gerencia o cadastro de usuários
    • Operações de recuperar senha
  3. Admin Backend
    • Gerencia as operações de administradores
    • Responsável por gerenciar congregações e departamentos
  4. Members
    • Gerenciar membros e históricos

INSTRUÇÕES DE INSTALAÇÃO

Pré-requisitos

Node version Npm version AWS-S3 Rabbit MongoDB

Etapas

1. Clone o Repositório

git clone https://github.com/Lipez-x/api-cad-assemblies.git
cd api-cad-assemblies

2. Instale as depêndencias

Navegue até cada pasta de microsserviços e no api-gateway e execute:

npm install

3. Configurar variáveis de ambiente

Você pode criar um arquivo .env e adicionar as variáveis conforme necessário em cada microsserviço e no api-gateway. Aqui está um exemplo de como configurar essas variáveis:

.env
// Configurações do RabbitMQ
RMQ_USER = rmq_user
RMQ_PASSWORD = rmq_password
RMQ_ADDRESS = rmq_address

// Configurações de JWT
JWT_SECRET = jwt_secret

// Configurações AWS
S3_USER_ACCESS_KEY_ID = s3_user_access_key_id
S3_USER_SECRET_ACCESS_KEY = s3_user_secret_access_key
AWS_REGION = aws_region
AWS_S3_BUCKET = aws_s3_bucket

// Configurações do banco de dados
DB_USER = root
DB_PASSWORD = password

// Configurações do SMTP
SMTP_HOST = smtp_host
SMTP_PORT = smtp_port
SMTP_USER = smtp_user
SMTP_PASSWORD = smtp_password

INSTRUÇÕES DE USO

As instruções detalhadas de uso estão disponíveis na documentação do Swagger, que pode ser acessada no seguinte endpoint:

Documentação

http://localhost:8080/api-docs/

About

Esta API foi criada para simplificar e otimizar o gerenciamento de membros, departamentos e congregações de uma igreja.

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages