Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gabrielfeijo/backend-revoluti
Este repositório contém o código backend para um projeto de CEP Finder desenvolvido para um desafio técnico da RevoluTI. Utiliza NestJS e Prisma para criar uma API que gerencia endereços, valida CEPs e mantém um histórico de pesquisas por usuário.
https://github.com/gabrielfeijo/backend-revoluti
nestjs nestjs-testing postgresql prisma typescript
Last synced: about 2 months ago
JSON representation
Este repositório contém o código backend para um projeto de CEP Finder desenvolvido para um desafio técnico da RevoluTI. Utiliza NestJS e Prisma para criar uma API que gerencia endereços, valida CEPs e mantém um histórico de pesquisas por usuário.
- Host: GitHub
- URL: https://github.com/gabrielfeijo/backend-revoluti
- Owner: GabrielFeijo
- Created: 2024-07-30T13:22:28.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-03T21:13:28.000Z (5 months ago)
- Last Synced: 2024-08-04T21:57:50.944Z (5 months ago)
- Topics: nestjs, nestjs-testing, postgresql, prisma, typescript
- Language: TypeScript
- Homepage:
- Size: 132 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://git-scm.com/downloads)
- [Node.js](https://nodejs.org/en)
- [Docker](https://www.docker.com/products/docker-desktop/)
### Instalando e Executando
```bash
# 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
```bash
# Execute os testes unitários
$ npm run test
```
## 🛠️ Feito utilizando
### BackEnd
### Deploy
