API REST desenvolvida utilizando o conceito de clean architecture e TDD. A aplicação é capaz de retornar as letras contidas em uma imagem de um captcha.
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
Você também vai precisar de uma conta na Google Cloud e um projeto utilizando Cloud Vision, um tutorial de como configurar o projeto será exibido a seguir:
Com uma conta Google Cloud criada, na dashboard principal siga os passos das imagem a seguir para criar um projeto.
Com o projeto criado, agora devemos ir para a dashboard do mesmo, para isso siga os passos das próximas imagens:
Agora será necessário adicionar a biblioteca Cloud Vision ao projeto, para isso siga os passos das próximas imagens:
Com a biblioteca Cloud Vision adicionada, necessitamos de uma conta de serviço para poder utilizar a aplicação, para isso siga os passos das próximas imagens:
Com a conta de serviço criada, necessitamos de uma chave para poder realizar as requisições, para isso siga os passos das próximas imagens:
Ao finalizar o processo, o download de um arquivo json contendo a chave da aplicação será gerado, renomeie-o para api-key.json e o adicione na raiz do projeto.
# Clone este repositório
$ git clone https://github.com/brunobrolesi/node-ocr-api.git
# Acesse a pasta do projeto no terminal/cmd
$ cd node-ocr-api
# Instale as dependências
$ npm install
# Defina as variáveis de ambiente em um arquivo .env seguindo o exemplo fornecido, pode-se apenas renomea-lo para .env para facilitar o processo
$ mv .env.example .env
# Rode os testes (opcional)
$ npm test
# Rode o comando de build
$ npm run build
# Inicie o projeto
$ npm start
# O servidor iniciará por padrão na porta:3000Para obter o texto de um determinado captcha, envie a imagem para o endpoint:
localhost:3000/api/letter-captcha
A imagem deve ser enviada no formato multipart/form-data utilizando a chave file
As seguintes ferramentas foram utilizadas na construção do projeto: