A guided web app for creating polished, export-ready GitHub profile README.md files. Supports dynamic widgets, tech stack icons, and live previews to help developers showcase their identity without manual markdown coding.

nextjs
NEXT.JS
react
REACT
ts
TYPESCRIPT
tailwind
TAILWIND CSS
vitest
VITEST
CategoryWEB APP
TimelineOct 2025 – Mar 2026
RoleLead Developer
StatusCompleted
01

Executive Summary

Manual markdown writing, searching for badge URLs, and configuring widgets for a GitHub profile can be time-consuming and error-prone.

GitHub Profile README Builder abstracts the complexity of markdown and widget configuration. The platform features a responsive, high-performance editor that provides immediate visual feedback.

02

Core Infrastructure

Spec 01

Guided 5-Step Workflow

Structured form covering Identity, Personal Info, Tech Stack, and Stats.

Spec 02

Live Markdown Preview

Real-time, GitHub-accurate preview of your profile.

Spec 03

Dynamic Widget Integration

One-click setup for stats, streaks, trophies, and WakaTime cards.

Spec 04

Tech Stack Picker

Searchable interface for hundreds of technology icons.

03

Design Philosophy

I wanted to eliminate the friction of manually writing complex Markdown. The vision was to provide a 'zero manual coding' experience for developers to showcase their identity through a guided 5-step workflow.

The Breakthrough

The realization that a profile's complexity could be distilled into a linear 'Identity to Stats' wizard, making a daunting task feel like a simple form-filling exercise.

04

Technical Architecture

Synchronizing a real-time, GitHub-accurate Markdown previewer while dynamically injecting hundreds of tech icons and third-party widgets like WakaTime and GitHub Trophies.

Engineered With

  • Next.js 15 (App Router)
  • React 19
  • TypeScript
  • Tailwind CSS 4
  • Lucide React
  • Vitest

Performance Goal

  • Zero-latency markdown rendering
  • Optimized asset loading for 100+ icons
  • Real-time state synchronization

System Integrity

  • Secure client-side data persistence
  • Safe external widget embedding
  • Sanitized markdown output
Vihara
Up Next

Vihara

A comprehensive accommodation booking platform for travelers and a robust property management system for vendors. Built with a scalable Nx monorepo, it handles end-to-end booking flows, Stripe payments, and optimized image management.

View