decoupled-postal-code-api

Sumário

• decoupled-postal-code-api
  • Sumário
  • Motivação
  • Pilha de tecnologia
  • Como rodar
    • Pré-requisitos
    • Passo a passo

Motivação

Este app consiste em uma aplicação TypeScript que armazena informações sobre CEPs (Código de Endereçamento Postal) e logradouros dos Correios. O app foi desenvolvido utilizando Prisma como ORM para permitir a alternância entre os Sistemas Gerenciadores de Banco de Dados MongoDB e PostgreSQL, permitindo realizar operações de CRUD para gerenciar esses dados. A aplicação foi desenvolvida com foco na simplicidade, utilizando tecnologias como TypeScript e Node.js para facilitar a construção e manutenção do código.

Este foi o sexto repositório de código apresentado no Curso Superior de TSI do IFMS como requisito para obtenção da nota parcial das atividades da unidade curricular Linguagem de Programação III.

← Repositório anterior	Próximo repositório →

Pilha de tecnologia

Papel	Tecnologia
Ambiente de execução	Node
Linguagem de programação	TypeScript
Virtualização de banco de dados	Docker
ORM	Prisma
Banco de dados1	MongoDB
Banco de dados2	PostgreSQL

Como rodar

Pré-requisitos

• Node;
• Yarn (opcional);
• Docker.

Passo a passo

1. Clone o repositório de código em sua máquina;

2. Abra um shell de comando de sua preferência (prompt de comando, PowerShell, terminal etc.);

3. Instale as dependências do projeto através do seguinte comando:

$ npm install

Caso esteja utilizando o gerenciador de pacotes Yarn, execute o seguinte comando como alternativa:

$ yarn

4. Com o Docker instalado, execute o comando abaixo para levantar o container Docker com o respectivo banco de dados virtualizado. Certifique-se de estar no diretório do arquivo docker-compose.yml;

$ docker-compose up -d

O parâmetro -d serve para desocupar o shell de comando logo após a execução do comando. É uma boa convenção, ao encerrar a execução do app, derrubar o container levantado através do comando:

$ docker-compose down

Mas, não se preocupe. As tuplas inseridas no banco de dados não serão deletadas com a derrubada do container.

5. Agora, para se certificar de que o Prisma está devidamente configurado em sua máquina, execute o seguinte comando:

$ yarn prisma

O script prisma está programado para criar uma nova migração no diretório prisma/migrations.

6. Finalmente, execute o seguinte comando para executar o app:

Para npm:

$ npm run start

Para Yarn:

$ yarn start