AdonisJS API

Este microsserviço foi desenvolvido em NodeJS e AdonisJS como framework. A seguir, darei o passo a passo de como clonar o repositório, intalar as dependências e rodar o projeto localmente.

🚀 Começando

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto, é imprescindível ter um editor para trabalhar com o código como VSCode. Optei pelo uso do PostgreSQL como banco relacional, então caso não tenha o mesmo instalado, será necessário que utilize o Docker ok?

📋 Pré-requisitos

As seguintes ferramentas foram usadas na construção do projeto:

Node.js ({ node: 17.4.0, npm: 8.8.0 })
TypeScript ({ tsc: 5.2.2 })

🔧 Instalação

# Clone este repositório
$ git clone git@github.com:gabrielhsantos/AdonisJS_API.git

# Acesse a pasta do projeto no terminal/cmd
$ cd AdonisJS_API

# Instale as dependências
$ npm ci

🎲 Banco de dados (servidor)

Caso utilize o PostgreSQL, basta executar os seguintes comandos:

# Execute as migrations
$ node ace migration:run

🐋 Container

Se a opção for o uso do Docker, existe na raiz do projeto um arquivo docker-compose, que irá instalar o PostgreSQL em um conteiner. Para isso, basta rodar esse comando:

# Subir o container Docker
$ npm run infra:up

Obs: ao subir a infra, o processo de migration e seed ocorrerá automaticamente.

Para derrubar o container e os volumes gerados, basta rodar:

# Remover o container Docker e volumes
$ npm run infra:down

Execute a aplicação

$ node ace serve

O servidor inciará na porta:3333.

⚙️ Executando os testes

Para rodar os testes, basta utilizar este comando via terminal/cmd:

# Irá rodar os testes de integração e unitários
$ node ace test

gabrielhsantos / AdonisJS_API