RevoluTI - Backend

Descrição do Projeto 📝

Este repositório contém o código backend para o projeto de CEP Finder, desenvolvido para um desafio técnico da empresa RevoluTI. A API gerencia endereços, valida CEPs e mantém um histórico de pesquisas por usuário.

Tecnologias Utilizadas ⚙

• NestJS: Framework Node.js para construir aplicações server-side com TypeScript.
• Prisma: ORM para interagir com o banco de dados.
• PostgreSQL: Banco de dados relacional para armazenamento de dados.
• TypeScript: Linguagem de programação para garantir tipagem estática e segurança no desenvolvimento.

Funcionalidades

• API para criação e gerenciamento de endereços.
• Validação de CEP e armazenamento de endereços.
• Manutenção do histórico de pesquisas por usuário.
• Documentação da API utilizando Swagger para facilitar o desenvolvimento e integração.

📄 Documentação

🚀 Começo

Para iniciar o projeto localmente:

Pré-requisitos

• Git
• Node.js
• Docker

Instalando e Executando

# Clone o repositório
$ git clone https://github.com/GabrielFeijo/Backend-RevoluTI

# Acesse a pasta do projeto
$ cd Backend-RevoluTI

# Instale as dependências
$ npm install

# Configure as variáveis de ambiente no arquivo .env. Utilize o arquivo .env.example para ajudar na configuração

# Inicie o banco de dados PostgreSQL usando Docker Compose
$ docker compose up -d

# Execute as migrações do Prisma
$ npx prisma migrate dev

# Inicie a aplicação
$ npm run start:dev

🧪 Executando Testes

# Execute os testes unitários
$ npm run test

🛠️ Feito utilizando

BackEnd

Deploy