crowe-api

🇬🇧 - English

Desafio da Crowe para candidatos. API.

A Crowe está iniciando um novo processo seletivo e solicitou ao setor de Tecnologia a criação de um formulário para cadastrar os candidatos que participarem desse processo seletivo.

Este repositório guarda o back-end do projeto. Baixe e instale o projeto crowe-web para ter a interface web.

• crowe-api
  • Features
  • Tecnologias
  • TODO
  • API
  • Como usar
    • Pré requisitos
    • Rodando o front-end (cliente)
    • Rodando o back-end (servidor)
  • Insomnia
  • Licença

Features

• Cadastro de candidatos
• Listagem de candidatos
• Exclusão de candidatos
• Edição de candidatos

Tecnologias

• AdonisJS
• Typescript
• SQLite3

TODO

• Cadastro
• Listagem
• Exclusão
• Exibição
• Edição
• Paginação

API

Método	Rota	Handler	Descrição
HEAD, GET	/applicants	ApplicantsController.index	Lista todos os candidatos
POST	/applicants/new	ApplicantsController.store	Cria dados de um novo candidato
HEAD, GET	/applicants/:id	ApplicantsController.show	Lista dados de um candidato específico, dado o ID
PUT	/applicants/:id	ApplicantsController.update	Atualiza dados de um candidato específico, dado o ID
DELETE	/applicants/:id	ApplicantsController.destroy	Apaga dados de um candidato específico, dado o ID

Como usar

Podemos considerar que este projeto está dividido em duas partes:

1. Front-end (crowe-web)
2. Back-end (este repositório)

O front-end precisa que o back-end esteja sendo executado para funcionar.

Pré requisitos

Antes de começar, você vai precisar ter instalado em sua máquina o Git e Node.js.

Rodando o front-end (cliente)

Baixe o repositório do front-end (necessário extrair os arquivos), seja clicando aqui ou clonando com:

$ git clone https://github.com/samuel-s-marques/crowe-web

Acesse a pasta do projeto no terminal/cmd

$ cd crowe-web

Instale as dependências com npm install

$ npm install

Execute a aplicação em modo de desenvolvimento

$ npm run serve

Rodando o back-end (servidor)

Baixe este repositório (necessário extrair os arquivos), seja clicando aqui ou clonando com:

$ git clone https://github.com/samuel-s-marques/crowe-api

Acesse a pasta do projeto no terminal/cmd

$ cd crowe-api

Instale as dependências com npm install

$ npm install

Defina no arquivo .env.example as configurações. Para obter o valor da chave APP_KEY, você terá de gerar através do comando

$ node ace generate:key

Após gerar, copie o valor dado e cole na chave APP_KEY, do .env.example.

PORT=3333
HOST=0.0.0.0
NODE_ENV=development
APP_KEY=Cole aqui!
DB_CONNECTION=sqlite

E, então, remova o sufixo .example do arquivo.

Execute a aplicação em modo de desenvolvimento

$ npm run dev

O servidor iniciará na porta :3333.

Insomnia

Caso queira testar a API, pode agilizar o processo pelo Insomnia.

Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.