How seman2-dev/gitfolio-md works
Gitfolio.md is a GitHub profile README builder with hosted SVG and data APIs. Users configure profile details, sections, and themes in the builder; GitHub imports and featured repositories supply data, while preview and Markdown generation produce a README that can be copied, downloaded, or shared. Hosted endpoints render matching SVGs and serve GitHub data, shares, and visitor counts. Edges reflect excerpts, source-index references, or README statements; unsampled routes are represented at their existing directories, and their internal wiring is not asserted.
Main entry points: BuilderClient.tsx Builder editor · api Image endpoints · Preview.tsx Live preview · markdown.ts README generator
Components 29
README Builder
- Landing page
app/page.tsx - Builder editor
components/BuilderClient.tsx - Profile panel
components/panels/ProfilePanel.tsx - Sections panel
components/panels/SectionsPanel.tsx - Theme panel
components/panels/ThemePanel.tsx - Content panel
components/panels/ContentPanel.tsx - Live preview
components/preview/Preview.tsx - Markdown view
components/preview/MarkdownView.tsx - Share dialog
components/ShareDialog.tsx
Content Generation
- Config defaults & safety
lib/config.ts - Section defaults
lib/defaults.ts - Theme resolution
lib/themes.ts - README generator
lib/markdown.ts - Skills & badges
lib/skills.ts - Social links
lib/socials.ts - SVG renderer
lib/svg.ts - Modern SVG designs
lib/svg-modern.ts - SVG design variants
lib/svg-variants.ts
Backend Services
- Browser API client
lib/api.ts - Image endpoints
app/api - GitHub data endpoints
app/api/github - Share endpoints
app/api/share - GitHub data service
lib/server/github.ts - HTTP response handling
lib/server/http.ts
Persistence & Controls
- Request validation
lib/server/validate.ts - Persistent store
lib/server/store.ts - Rate limiting
lib/server/ratelimit.ts
Other components
- README author
- GitHub API
Connections 39
- README author → Landing page: opens
README.md - README author → Builder editor: configures
README.md - Builder editor → Profile panel: renders
components/BuilderClient.tsx - Builder editor → Sections panel: renders
components/BuilderClient.tsx - Builder editor → Theme panel: renders
components/BuilderClient.tsx - Builder editor → Content panel: renders
components/BuilderClient.tsx - Builder editor → Live preview: previews
components/BuilderClient.tsx - Builder editor → Markdown view: shows
components/BuilderClient.tsx - Builder editor → Share dialog: opens
components/BuilderClient.tsx - Builder editor → Browser API client: fetches data
components/BuilderClient.tsx - Builder editor → README generator: generates
components/BuilderClient.tsx - Builder editor → Config defaults & safety: loads config
components/BuilderClient.tsx - Builder editor → Section defaults: initializes
components/BuilderClient.tsx - Share dialog → Browser API client: saves or loads
components/ShareDialog.tsx - Live preview → SVG renderer: renders SVG
components/preview/Preview.tsx - Live preview → README generator: uses helpers
components/preview/Preview.tsx - Live preview → Skills & badges: formats badges
components/preview/Preview.tsx - Live preview → Theme resolution: resolves theme
components/preview/Preview.tsx - README generator → Theme resolution: uses presets
lib/markdown.ts - README generator → Skills & badges: uses badges
lib/markdown.ts - README generator → Social links: formats links
lib/markdown.ts - SVG renderer → Modern SVG designs: dispatches designs
lib/svg.ts - SVG renderer → SVG design variants: dispatches designs
lib/svg.ts - SVG renderer → Theme resolution: resolves colors
lib/svg.ts - Image endpoints → SVG renderer: renders images
app/api/activity/route.ts - Image endpoints → HTTP response handling: wraps responses
app/api/activity/route.ts - Image endpoints → Request validation: parses queries
app/api/activity/route.ts - Image endpoints → GitHub data service: loads profile data
app/api/activity/route.ts - Image endpoints → Persistent store: updates counters
app/api/visitors/route.ts - Image endpoints → Rate limiting: checks client IP
app/api/visitors/route.ts - GitHub data endpoints → GitHub data service: serves GitHub data
README.md - GitHub data service → GitHub API: requests data
lib/server/github.ts - HTTP response handling → Rate limiting: checks limits
lib/server/http.ts - Share endpoints → Persistent store: saves or loads
app/api/share/route.ts - Share endpoints → Config defaults & safety: sanitizes designs
app/api/share/route.ts - Share endpoints → HTTP response handling: returns responses
app/api/share/route.ts - Request validation → Theme resolution: parses theme
lib/server/validate.ts - Request validation → GitHub data service: uses errors
lib/server/validate.ts - Persistent store → README author: retains counts
README.md