Recruitment API

API para gestão de vagas

Tecnologias

Node.js
Nest.js
PostgreSQL

Configuração local

Tenha certeza que o Node.js (>=16.13.2) esteja instalado em sua máquina, caso contrário, instale-o com o utilitário nvm através do comando nvm install na raíz do projeto. Além disso, certifique-se que o Docker está sendo executado para utilizar o banco de dados localmente.

# Faz o download das dependências do projeto com o Yarn
$ yarn

# Inicializa um container do postgresql em background através do Docker Compose
$ docker-compose up -d

Ao vivo

A aplicação está deployada na Digital Ocean através do serviço App Platform e o banco de dados está no serviço Supabase.

Endereço da aplicação: https://recruitment-api-tiblj.ondigitalocean.app

Executando localment

Para interagir com os endpoints disponíveis, utilize a collection disponível em docs/collections/insomnia-recruitment-api.json através do programa Insomnia.

# Inicializa a aplicação em modo de desenvolvimento local com hot reload
$ yarn start:dev

# Inicializa a aplicação em modo de produção (`NODE_ENV === 'production'`)
$ yarn start:prod

Testes

# Executa todos os casos de teste
$ yarn test

Melhorias

Documentação dos endpoints com Swagger/OpenAPI;
Versionamento dos endpoints;
Acertar tipagem/DTO de alguns endpoints;
Adicionar Github Action para checagem dos testes à cada novo commit;