{"id":30344930,"url":"https://github.com/kauefraga/rinhers","last_synced_at":"2025-08-18T13:25:23.761Z","repository":{"id":304572862,"uuid":"1018771014","full_name":"kauefraga/rinhers","owner":"kauefraga","description":"Conheça os participantes e suas soluções da Rinha de Back end 2025, a competição mais aguardada do ano!","archived":false,"fork":false,"pushed_at":"2025-08-18T11:09:23.000Z","size":3641,"stargazers_count":13,"open_issues_count":6,"forks_count":6,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-18T11:22:59.753Z","etag":null,"topics":["2025","competition","ranking","rinha-de-backend"],"latest_commit_sha":null,"homepage":"https://rinhers.kauefraga.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kauefraga.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-13T02:25:34.000Z","updated_at":"2025-08-18T11:09:27.000Z","dependencies_parsed_at":"2025-07-14T01:27:29.948Z","dependency_job_id":"eef277e7-2862-4350-a6e9-0c397f0332e7","html_url":"https://github.com/kauefraga/rinhers","commit_stats":null,"previous_names":["kauefraga/rinhers"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kauefraga/rinhers","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Frinhers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Frinhers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Frinhers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Frinhers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kauefraga","download_url":"https://codeload.github.com/kauefraga/rinhers/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kauefraga%2Frinhers/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270999495,"owners_count":24682460,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-18T02:00:08.743Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["2025","competition","ranking","rinha-de-backend"],"created_at":"2025-08-18T13:25:21.520Z","updated_at":"2025-08-18T13:25:23.725Z","avatar_url":"https://github.com/kauefraga.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rinhers™\n\n[![acesse rinhers.kauefraga.dev](https://img.shields.io/badge/acesse-rinhers.kauefraga.dev-7a02ff?labelColor=3068d7)](https://rinhers.kauefraga.dev)\n[![Licença do projeto](https://img.shields.io/github/license/kauefraga/rinhers)](https://github.com/kauefraga/rinhers/blob/main/LICENSE)\n[![Último commit](https://img.shields.io/github/last-commit/kauefraga/rinhers/main)](https://github.com/kauefraga/rinhers)\n\nConheça os participantes e suas soluções da [Rinha de Back end 2025](https://github.com/zanfranceschi/rinha-de-backend-2025), a competição mais aguardada do ano!\n\n\u003cdiv align=\"center\"\u003e\n\n![Demonstração do uso do Rinhers™](docs/demo.gif)\n\n\u003c/div\u003e\n\n## Funcionalidades\n\n- Conhecer os Rinhers em uma interface intuitiva, descontraída e responsiva\n- Pesquisar e filtrar participantes por nome, linguagem de programação ou tecnologias usadas\n- Trocar entre o tema claro e escuro\n- Receber atualização automática dos participantes todo dia às 21h (horário de Brasília).\n\n## Como rodar localmente\n\nTenha o [bun](https://bun.sh) instalado na sua máquina. Node.js e NPM também funciona.\n\nPrimeiro clone o projeto e instale as dependências\n\n```sh\ngit clone https://github.com/kauefraga/rinhers.git\n\ncd rinhers\n\nbun install\n```\n\nInicie o front end em modo de desenvolvimento\n\n```sh\nbun dev\n```\n\nExecute o script que gera o arquivo `rinhers.json`\n\n```sh\nbun gen\n```\n\n\u003e [!WARNING]\n\u003e Para executar o script é necessário preencher a variável de ambiente `GITHUB_AUTH_TOKEN` com [um token de acesso pessoal (clássico)](https://docs.github.com/pt/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#como-criar-um-personal-access-token-classic) que tenha a permissão `public_repo`.\n\n```sh\necho \"GITHUB_AUTH_TOKEN=\" \u003e .env\n```\n\n## Funcionamento do projeto\n\n![Diagrama simplificado do funcionamento do projeto](docs/howitworks.png)\n\nO front end lê o arquivo `rinhers.json`, que é gerado e adicionado ao bundle da aplicação (`import`).\n\nAnalisando a trajetória até os dados foi possível definir que seria melhor gerar um arquivo com todos os dados uma única vez, ao invés de consumir a API do GitHub diretamente a cada requisição para página (mesmo com cache).\n\nO script faz uma chamada para o endpoint `https://api.github.com/repos/zanfranceschi/rinha-de-backend-2025/contents/participantes` para conhecer todos os diretórios que existem e depois mapear eles para URLs `https://raw.githubusercontent.com/zanfranceschi/rinha-de-backend-2025/main/participantes/{submissao}/info.json`.\n\nAs URLs são separadas em chunks, depois os arquivos json são consultados usando `fetch` e `Promise.allSettled`. Os resultados são agregados em memória.\n\nNo final o resultado é convertido no arquivo `rinhers.json`.\n\nNovas versões do arquivo são geradas automaticamente todo dia por causa de um [pipeline agendado do GitHub Action](.github/workflows/main.yml).\n\n###### Melhorias\n\n- **Trees API**: A API do GitHub em uso é chamada de *Contents API*, ela puxa no máximo 1000 registros por diretório, ou seja, se a Rinha vier a ter mais de 1000 participantes o excedente não vai ser incluso. Pelo que pesquisei a *Trees API* não tem essa limitação.\n- **Streams**: Usar streams e escrever os resultados no arquivo `rinhers.json` sob demanda é mais eficiente e escalável do que colocar os resultados direto na memória.\n\n### Tecnologias\n\n- [TypeScript](https://www.typescriptlang.org/) 💙\n- [Bun](https://bun.sh/)\n- [GitHub API](https://docs.github.com/pt/rest)\n- [React](https://react.dev/)\n- [TailwindCSS](https://tailwindcss.com/)\n- [Lucide](https://lucide.dev/icons/)\n- [Cloudflare Pages](https://pages.cloudflare.com/)\n- [GitHub Actions](https://docs.github.com/pt/actions)\n\nO ícone do projeto foi feito usando [ray.so](https://ray.so/icon).\n\n## Contribuições\n\nFique à vontade para contribuir [abrindo uma issue](https://github.com/kauefraga/rinhers/issues/new) para reportar um bug, sugerir uma alteração na interface, uma melhoria ou uma nova funcionalidade.\n\n### Como contribuir\n\n1. Faça um *fork* do projeto\n2. Clone seu *fork* na sua máquina\n3. Prepare o [ambiente de desenvolvimento](#como-rodar-localmente)\n4. Faça as alterações e *commit* elas com [mensagens descritivas](https://www.conventionalcommits.org/pt-br/v1.0.0/)\n5. Sincronize as alterações com o repositório do seu *fork* (`git push`)\n6. Abra um *pull request* especificando o que você fez de forma geral (considerando que as alterações têm seus *commits* descritivos)\n\n### Contribuidores e apoiadores\n\nMeus agradecimentos a essas pessoas incríveis por ajudarem a aprimorar o projeto ou por incentivarem a continuação do projeto por meio de doações:\n\n\u003ca href=\"https://github.com/willy-r\"\u003e\u003cimg width=\"60\" src=\"https://github.com/willy-r.png\" alt=\"perfil de willy-r\" /\u003e\u003c/a\u003e\n\n## Licença\n\nEste projeto está sob a licença MIT - Veja a [LICENÇA](LICENSE) para mais informações.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkauefraga%2Frinhers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkauefraga%2Frinhers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkauefraga%2Frinhers/lists"}