Sistema de Gerenciamento de Correspondências

Sobre o projeto • Tecnologias utilizadas • Como executar

ℹ️ Sobre o projeto

Essa API faz parte de um projeto cuja finalidade é permitir que pessoas que não possuem entrega domiciliar de correspondências fique sabendo quando há correspondências para serem retiradas nas agências de serviço postal, para não "perder a viagem" 😁. As correspondências são cadastradas em uma Aplicação Web e são contabilizadas aparecendo para o usuário do aplicativo.

💻 Tecnologias utilizadas

Este projeto foi desenvolvido utilizando as seguintes tecnologias:

• NodeJs
• Typescript
• cors
• dotenv
• EditorConfig
• ESLint
• Express
• JSON Web Token
• Prettier
• TypeORM

🚀 Como executar

💻 Executando o projeto

Para clonar e executar este projeto, você precisará do Git, Node.js + Yarn instalado no seu computador. Também é ideal possuir um editor para trabalhar com o código como Visual Studio Code. O banco de dados utilizado neste projeto é o PostgreSQL.

⬇️ Baixando o projeto

# Clone o repositório na sua máquina
$ git clone https://github.com/w-reis/postex-api.git

Depois de clonado, execute os comandos a seguir:

# Vá para a pasta do projeto
$ cd postex-api/

# Instale as dependências
$ yarn

Antes de dar start no servidor, abra o arquivo ".env.example" localizado na raiz do projeto e preencha com as credenciais do seu banco de dados Postgres.

Adicione também as "secrets" que serão utilizadas na autenticação via JWT(Json Web Token).

Salve e renomeie o arquivo para ".env"

Feito isso, execute as migrations e inicie o servidor:

#Execute as migrations
$ yarn typeorm migration:run

#Execute a aplicação
$ yarn dev:server

Feito com paixão por Wellinton Reis 🚀.

Dê uma ⭐️ se este projeto ajudou você!