Skip to content

vanribeiro/vanribeiro-github-io-backend

Repository files navigation

Back-end: site vanribeiro.github.io

Conteúdo

  1. Motivação
  2. Tecnologias
  3. Uso
  4. Links úteis

Motivação

Atualmente, meu site está hospedado no Github Pages e o serviço oferecido por eles só permite hospedar páginas estáticas. Como eu queria manter a hospedagem ali, o repositório público e também queria consumir alguns serviços de terceiros, como a API do Instagram, por exemplo, tive que procurar outra alternativa, já que algumas APIs fornecem uma chave de acesso, que, para mim, tem o mesmo nível de senha e deve ser protegida.

Na primeira versão, usei NodeJS com ExpressJS para criar uma API, que fazia as consulta usando as chaves de API, mas começou a apresentar alguns problemas de compatibilidade com o serviço da Vercel, especialmente com a versão do NodeJS que eu estava utilizando.

Então, optei por fazer um upgrade do NodeJS e também migrar de ExpressJS para Serveless Function da Vercel.

Tecnologias

Uso

localhost

  1. Instale todas as dependências: npm install

Executando a aplicação

  1. Se ainda não tiver instalado, instale o pacote da Vercel: npm i -g vercel
  2. Então, execute vercel dev
  3. A aplicação ficará disponível em http://localhost:3000

Documentação

Ao abrir http://localhost:3000, uma documentação, que foi gerada usando Typedoc, através de js comments ficará disponível.

Para facilitar as consultas aos enpoints, um Swagger está disponível em http://localhost:3000/swagger.

Ambos podem ser consultados, também, nos links abaixo

Testes

Os comandos configurados são:

  • npm run test - sem coverage
  • npm run test:coverage - com coverage
  • npm run test:watch - sem coverage e com --watchAll habilitado

Links úteis