{"id":51301543,"url":"https://github.com/teles/gitkut","last_synced_at":"2026-06-30T20:02:23.906Z","repository":{"id":357024836,"uuid":"1234467222","full_name":"teles/gitkut","owner":"teles","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-11T00:05:28.000Z","size":240,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-11T02:18:58.608Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/teles.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-10T08:10:15.000Z","updated_at":"2026-05-11T00:05:32.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/teles/gitkut","commit_stats":null,"previous_names":["teles/gitkut"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/teles/gitkut","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teles%2Fgitkut","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teles%2Fgitkut/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teles%2Fgitkut/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teles%2Fgitkut/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teles","download_url":"https://codeload.github.com/teles/gitkut/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teles%2Fgitkut/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34981391,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-30T02:00:05.919Z","response_time":92,"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":[],"created_at":"2026-06-30T20:02:20.734Z","updated_at":"2026-06-30T20:02:23.881Z","avatar_url":"https://github.com/teles.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gitkut\n\nGitkut e uma pagina social retro para devs, usando dados publicos do GitHub.\n\nEsta implementacao inicial roda localmente com:\n\n- `api/`: Cloudflare Worker + Hono + TypeScript + Wrangler, OAuth com GitHub e cookies `httpOnly`\n- `web/`: Nuxt, tela de login e pagina retro do perfil\n\n## Estrutura\n\n```text\ngitkut/\n├─ api/\n└─ web/\n```\n\n## Criar OAuth App no GitHub\n\n1. Acesse GitHub \u003e Settings \u003e Developer settings \u003e OAuth Apps.\n2. Clique em \"New OAuth App\".\n3. Use estes valores para desenvolvimento local:\n   - Application name: `Gitkut Local`\n   - Homepage URL: `http://localhost:5173`\n   - Authorization callback URL: `http://localhost:8787/auth/github/callback`\n4. Copie o `Client ID`.\n5. Gere um `Client secret`.\n\nPara producao, use outro OAuth App ou atualize o app de producao com:\n\n- Application name: `Gitkut`\n- Homepage URL: `https://gitkut.com`\n- Authorization callback URL: `https://api.gitkut.com/auth/github/callback`\n\nGitHub OAuth Apps aceitam apenas uma callback URL cadastrada. Por isso, o fluxo\nmais simples e ter um OAuth App para local e outro OAuth App para producao. Se o\nGitHub mostrar que o `redirect_uri` nao esta associado ao app, confira se o\n`Client ID` usado no Cloudflare pertence ao app cuja callback URL e\n`https://api.gitkut.com/auth/github/callback`.\n\n## Configurar ambiente\n\nBackend:\n\n```bash\ncd api\ncp .env.example .env\n```\n\nEdite `api/.env`:\n\n```env\nGITHUB_CLIENT_ID=\"seu_client_id\"\nGITHUB_CLIENT_SECRET=\"seu_client_secret\"\nGITHUB_CALLBACK_URL=\"http://localhost:8787/auth/github/callback\"\nFRONTEND_URL=\"http://localhost:5173\"\nCORS_ALLOWED_ORIGINS=\"http://localhost:5173,http://127.0.0.1:5173\"\nCOOKIE_SECURE=\"false\"\nCOOKIE_SAME_SITE=\"Lax\"\n```\n\nO backend usa somente `api/.env` no desenvolvimento local. Nao mantenha um\nsegundo arquivo `api/.dev.vars`, para evitar configuracoes divergentes.\n`CORS_ALLOWED_ORIGINS` aceita uma lista separada por virgula quando houver\nmais de uma origem web autorizada a chamar a API com cookies.\n\nFrontend:\n\n```bash\ncd web\ncp .env.example .env\n```\n\nO front usa apenas a URL publica da API local:\n\n```env\nNUXT_PUBLIC_API_URL=http://localhost:8787\nNUXT_PUBLIC_USE_MSW=false\n```\n\n## Instalar dependencias\n\nNa raiz do projeto:\n\n```bash\npnpm install\n```\n\nIsso instala as dependencias de `api/` e `web/`.\n\nSe preferir instalar separadamente:\n\n```bash\npnpm --dir api install\npnpm --dir web install\n```\n\n## Rodar localmente\n\nTerminal 1:\n\n```bash\npnpm dev:api\n```\n\nAPI local: `http://localhost:8787`\n\nTerminal 2:\n\n```bash\npnpm dev:web\n```\n\nWeb local: `http://localhost:5173`\n\nDepois abra `http://localhost:5173` e clique em \"Entrar com GitHub\".\n\n## Frontend tooling\n\nO frontend usa Nuxt em modo hibrido no Cloudflare Pages: a home autenticada\ncontinua client-side e os perfis publicos de um segmento, como `/teles`, podem\nser renderizados com SSR na edge.\n\nStorybook:\n\n```bash\npnpm storybook:web\n```\n\nStorybook local: `http://localhost:6006`\n\nBuild do frontend:\n\n```bash\npnpm build:web\n```\n\nBuild do Storybook:\n\n```bash\npnpm build-storybook:web\n```\n\nQualidade:\n\n```bash\npnpm format:check\npnpm test:web\npnpm typecheck:web\n```\n\nPara simular a API no frontend local com MSW:\n\n```bash\ncd web\nNUXT_PUBLIC_USE_MSW=true pnpm dev\n```\n\nSem `NUXT_PUBLIC_USE_MSW=true`, o frontend continua usando a API real em\n`NUXT_PUBLIC_API_URL`.\n\n## Backend Worker\n\nO backend roda como Cloudflare Worker local via Wrangler.\n\nHealthcheck:\n\n```bash\ncurl http://localhost:8787/health\n```\n\nTypecheck:\n\n```bash\npnpm typecheck:api\n```\n\nTestes:\n\n```bash\npnpm test:api\n```\n\nD1 migrations:\n\n```bash\npnpm db:migrations:local\npnpm db:migrations:remote\n```\n\nDeploy futuro:\n\n```bash\npnpm deploy:api\n```\n\nQuando o Worker estiver conectado ao GitHub pelo Cloudflare Builds usando a\nraiz do monorepo, configure o comando de deploy como:\n\n```bash\npnpm run deploy\n```\n\nou:\n\n```bash\npnpm deploy:api\n```\n\nNao use `npx wrangler deploy` na raiz do repositorio: o Wrangler nao consegue\ndetectar qual aplicacao do workspace deve ser publicada. Tambem evite\n`pnpm deploy` sem `run`, porque esse e um comando nativo do pnpm, nao o script\ndo projeto. Se preferir configurar o root directory do build como `api/`, use\n`pnpm deploy` dentro desse diretorio.\n\nDeploy do frontend no Cloudflare Pages:\n\n```bash\npnpm build:web:prod\npnpm deploy:web\n```\n\nO build Nuxt para Cloudflare Pages gera a saida em `web/dist`, que e o\ndiretorio publicado no deploy direto. Headers de seguranca para assets\nestaticos ficam em `web/public/_headers`; respostas SSR tambem recebem esses\nheaders por `web/server/middleware/security-headers.ts`.\n\nURLs atuais:\n\n- Frontend: `https://gitkut.com`\n- Perfil publico exemplo: `https://gitkut.com/teles`\n- Backend Worker: `https://api.gitkut.com`\n- Callback OAuth de producao: `https://api.gitkut.com/auth/github/callback`\n\nEm producao, configure as variaveis no Cloudflare e use secrets para valores\nsensiveis:\n\n```bash\ncd api\npnpm wrangler secret put GITHUB_CLIENT_ID\npnpm wrangler secret put GITHUB_CLIENT_SECRET\n```\n\nVeja tambem `api/README.md` para os detalhes do Worker.\n\n## Banco D1\n\nO backend usa um banco Cloudflare D1 chamado `gitkut-db`, exposto no Worker\npelo binding `DB`.\n\nA primeira migration cria a base social do Gitkut:\n\n- `users`: vinculo local com o usuario do GitHub.\n- `profiles`: dados editaveis do perfil Gitkut.\n- `featured_repos`: repositorios fixados pelo usuario.\n- `scraps`: recados entre perfis.\n- `communities` e `user_communities`: comunidades e participacao.\n- `badges` e `user_badges`: trofeus e conquistas.\n- `profile_views_daily`: views agregadas por dia.\n\nDurante o callback OAuth, o Worker sincroniza o usuario autenticado em\n`users` e cria um `profiles` inicial quando ainda nao existir.\n\n## Perfis publicos\n\nCada perfil publico usa o `slug` salvo em `profiles.slug`.\n\nExemplo:\n\n```text\nhttps://gitkut.com/teles\n```\n\nO frontend trata URLs com um unico segmento como perfil publico, exceto slugs\nreservados do produto como `api`, `auth`, `settings`, `communities`,\n`profile`, `repos`, `privacy` e `terms`.\n\nCom SSR habilitado no Nuxt, essas rotas publicas sao atendidas pela propria\nrota `web/src/pages/[slug].vue`, sem fallback de SPA em `_redirects`.\n\n## Rotas da API\n\n- `GET /health`: retorna `{ \"ok\": true }`.\n- `GET /auth/github`: redireciona para o login do GitHub.\n- `GET /auth/github/callback`: recebe o `code`, troca por `access_token`, salva o token em cookie `httpOnly` e volta para o front.\n- `POST /auth/logout`: remove o cookie local de autenticacao.\n- `GET /api/me`: retorna dados basicos do usuario autenticado.\n- `GET /api/profile`: retorna o perfil Gitkut salvo no D1 para o usuario autenticado.\n- `GET /api/profiles/:slug`: retorna um perfil publico salvo no D1 e repos publicos recentes do GitHub.\n- `GET /api/repos`: retorna repositorios publicos recentes do usuario autenticado.\n\nO `GITHUB_CLIENT_SECRET` fica somente no backend. O frontend nunca recebe nem envia esse valor.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteles%2Fgitkut","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteles%2Fgitkut","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteles%2Fgitkut/lists"}