Olá, este é um repositorio referente a vaga de desenvolvedor back end!

Para correta instalação e execução desse projeto, é recomendada ter globalmente instalado "node, npm, yarn" (Necessário ter o Docker instalado também).

Instalação

Utilize o comando npm install para instalar as dependencias logo após o git clone.

Execução

docker-compose build && docker-compose up -d para iniciar o container.

Documentação

Dependencias

• Typescript
• NodeJs
• MongoDB
• Express
• Mongoose
• Docker

Docker

Para que possa iniciar a aplicação, é necessário utilizar o comando abaixo:
docker-compose build && docker-compose up -d

Após isso, a aplicação estará em execução. (Utilizando este comando, ele automaticamente executa npm install && npm run dev, sendo assim, instalando suas dependencias!)

IMPORTANTE - Aguarde até que a aplicação tenha seu carregamento concluido para poder fazer as requisições.

O servidor da aplicação ficará rodando nas variaveis locais informadas no projeto (.env)

Requisições

• /populate

Em primeira instância, deve-se acessar a rota /populate para que seja realizado o fetch na API fornecida no teste e popule o banco de dados com as informações.

• /universities
  Nesta rotá onde sera possivel realizar as operações (CRUD)
  

• GET
  Usando GET, retornará as 20 primeiras universidades de cada um dos países populados do banco.

  • Filter
    Permitido filtro de busca por pais e navegação de paginas. (limite de 20 por pagina) Ex: localhost:3000/universities?country=brazil&page=3
    

• GET:ID
  Retornando dados da busca da universidade pelo ID da mesma. Ex: localhost:3000/universities/32381733823da
  

• POST
  Metodo para cadastro de Universidades, permitindo os campos (alpha_two_code, web_pages, name, country, domains, state-province). Não permitindo cadastrar outra universidade com mesmo nome na mesma collection.

• PUT
  Buscando a universiade pelo ID e permitindo alterar os campos (web_pages, name, domains);

• DELETE
  Buscando a universidade pelo ID e permitindo DELETAR a mesma.