/dio-users-api

A API for accessing users' data at Digital Innovation One (DIO)

Primary LanguageTypeScriptMIT LicenseMIT

DIO User API šŸ±ā€šŸ‰

Este projeto Ć© uma API para gerar imagens das principais skills estudadas na plataforma DIO.

Podemos gerar a seguinte imagem indicando apenas o nome do usuƔrio:
Imagem com exemplo de Skills


A ideia foi inspirada no famoso Github Stats Card, usado para gerar imagens dinĆ¢micas das linguagens mais usadas por cada desenvolvedor a partir da anĆ”lise de seus repositĆ³rios no Github.

Exemplo de uso em ambiente local šŸ”

  1. Para rodar o ambiente localmente, clone o repositĆ³rio com o comando: git clone https://github.com/Pitossomo/dio-users-api.git

  2. Instale as dependĆŖncias com o comando npm install

  3. Na raiz do projeto, crie o arquivo .env.local com as variƔveis:

DIO_USERNAME=email.cadastrado.na.dio@exemplo.com
DIO_PASSWORD=senhaNaDIO

  1. Rode o servidor em modo de desenvolvimento com o comando: npm run dev

  2. No navegador, abra a pƔgina http://localhost:3000/api/v1/skills?username=pedro_h_teles, alterando o nome de usuƔrio como desejar

  3. Para encontrar o seu nome de usuƔrio, visite seu perfil e veja o nome na barra de endereƧo. Por exemplo, na imagem abaixo o nome do usuƔrio Ʃ pedro_h_teles: Captura de tela do perfil

  4. Na primeira visita, aguarde o tempo para o carregamento. Nas visitas futuras, o carregamento serĆ” instantĆ¢neo, desde que o servidor nĆ£o seja reinicializado e o nome do usuĆ”rio seja o mesmo.

Propostas futuras

Hospedar o projeto em um servidor para criar as imagens dinĆ¢micamente. Por se tratar de um projeto com alta latĆŖncia, o custo de hospedagem ficou bem alto, sendo

ObservaĆ§Ć£o importante ā—

A pĆ”gina dos usuĆ”rios Ć© acessĆ­vel apenas aos usuĆ”rios cadastradas na plataforma, e demanda autenticaĆ§Ć£o.

Para possibilitar a coleta das informaƧƵes, foi utilizada a biblioteca Puppeteer, o que demanda um alto tempo de processamento, jĆ” que nĆ£o existe API para acessar diretamente os dados do usuĆ”rio.

Sendo assim, a fim de minimizar o custo operacional e o impacto na plataforma, as imagens sĆ£o salvas em cache no servidor durante 7 dias. A primeira requisiĆ§Ć£o demora alguns segundos para ser gerada pelo servidor, e as requisiƧƵes posteriores sĆ£o resolvidas instantaneamente. Se o servidor reiniciar, o cache desaparece.