Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 1.76 KB

README.md

File metadata and controls

67 lines (43 loc) · 1.76 KB
Raw

Projetos Ativos API

Requisitos

Execução

  1. Clone este projeto

  2. Copie o arquivo .env.exemple e o renomeie para .env

  3. Adicione seu token do GitHub ao arquivo .env

    GITHUB_TOKEN=github_pat_11AM..

  4. Instale as dependências

    npm install

  5. Compile e execute o projeto

    npm run build && npm run start

Development

# Dependências
npm install

npm run start:dev

Acesse: http://localhost:5000

Build

# Dependências
npm install

npm run build

npm run start

GitHub Token

Para evitar erro de limitação de taxa utilize um token do GitHub. O limite de taxa restringe chamadas para a API do GitHub.

O token pode ser obtido na sua conta do GitHub em Settings → Developer settings → Personal access tokens → Fine-grained tokens.

No arquivo .env adicione seu token em GITHUB_TOKEN seguindo o exemplo do arquivo .env.exemple.

GITHUB_TOKEN=github_pat_11AM...

CronJob

Deve ser sincronizado o tempo de cache com a tarefa programada cron. O tempo de cache deve ser menor que o tempo que a tarefa cron será executada, por exemplo: Se a tarefa cron for executada a cada 24 horas, o cache deve ser ajustado para menos de 24 horas, ou seja, 23 horas e 59 segundos. Isso se dá para que a tarefa seja executada sempre que não houver dados em cache. De qualquer forma, a tarefa pode ser executada a qualquer momento, ja que será verificado primeiro se os dados estão em cache, podendo ser ajustada para ser verificado a cada 1 hora, por exemplo.