Create a polished GitHub profile README in minutes. A focused Next.js application with a live preview, selectable sections, accent colors, Markdown copy, file download, and optional OpenAI text generation.
- Next.js
16.3.0 - React
19.2 - TypeScript
- Tailwind CSS 4
pnpm install
pnpm run devOpen http://localhost:3000 in your browser.
The AI button uses the server-side OpenAI SDK through /api/generate. Create a local environment file and add your API key:
Copy-Item .env.example .env.localThen edit .env.local:
OPENAI_API_KEY=sk-your-key-here
OPENAI_MODEL=gpt-5.4-miniThe API key is never sent to the browser. The route uses the OpenAI Responses API with store: false. PDF, DOCX, TXT and Markdown files are sent as OpenAI input_file context when the user generates a README.
The Load button calls GitHub's public REST API through /api/github and collects the profile, public repositories, primary languages, followers and recent public events. A GITHUB_TOKEN is optional and is kept server-side; it only helps with rate limits.
LinkedIn is intentionally user-provided as a URL and optional pasted summary. The application does not scrape LinkedIn profiles.
The generator includes three narrative styles based on the analyzed reference profiles:
- Signature: expressive identity, visual badges, journey and personal voice.
- Recruiter: concise positioning, skills, projects, proof and contact CTA.
- Open source: contribution momentum, community work, milestones and impact.
All generated content is instructed to use real GitHub links and numbers only, avoid empty sections, and add Markdown visual modules such as shields, stat cards, activity widgets and Mermaid journeys when the selected data supports them.
pnpm run dev # Start the development server
pnpm run lint # Check the codebase
pnpm run build # Create a production build
pnpm run start # Run the production buildMIT © 2026