How maurodesouza/profile-readme-generator works
Profile README Generator is a localized web app for assembling a customized GitHub profile README. The central workflow is to configure and arrange profile sections on the canvas, generate a README preview/result, and optionally import an existing generated README back into editable sections. The tree also shows section-specific capabilities for stats, socials, techs, music, activities, images, borders, and contribution games. Relationship evidence is limited to the README and indexed excerpts; unshown runtime wiring is omitted.
Main entry points: layout.tsx Localized app · canvas/index.tsx Canvas commands · page.tsx Canvas page · canvas/index.tsx Canvas template
Components 20
App experience
- Localized app
src/app/[locale]/layout.tsx - Canvas page
src/app/[locale]/page.tsx - Result page
src/app/[locale]/result/page.tsx
README editor
- Canvas UI
src/components/organisms/canvas/index.tsx - Editor panels
src/components/organisms/panel/index.tsx - Panel registry
src/components/organisms/panels/panels.ts - README result
src/components/organisms/readme-result/index.tsx - Canvas template
src/components/templates/canvas/index.tsx - Result template
src/components/templates/result/index.tsx
Profile sections
- Section catalog
src/features/index.tsx - Section features
src/features
Editor runtime
- README importer
src/utils/parsers/from-readme/index.ts - Section importers
src/features - Section parsers
src/features - Image URL builders
src/utils/url/index.ts - Canvas commands
src/components/handles/canvas/index.tsx - Canvas state
src/stores/canvas-store/index.ts - Command bus
src/lib/command/command-bus.ts - Settings handle
src/components/handles/settings/index.tsx
Other components
- README author
Connections 20
- README author → Canvas page: opens editor
README.md - Localized app → Canvas page: hosts route
src/app/[locale]/layout.tsx - Localized app → Section catalog: renders
src/app/[locale]/layout.tsx - Localized app → Canvas commands: registers handlers
src/app/[locale]/layout.tsx - Canvas page → Canvas template: renders
- Canvas template → Canvas UI: renders
- Canvas template → Editor panels: renders
- Editor panels → Panel registry: reads panels
src/components/organisms/panel/index.tsx - Panel registry → Section features: registers panels
src/components/organisms/panels/panels.ts - Section catalog → Section features: loads features
src/app/[locale]/layout.tsx - Canvas commands → Command bus: registers commands
src/components/handles/canvas/index.tsx - Canvas commands → Canvas state: updates state
src/components/handles/canvas/index.tsx - Canvas commands → README importer: parses imported file
src/components/handles/canvas/index.tsx - README importer → Section importers: dispatches imports
src/utils/parsers/from-readme/index.ts - Section features → Section parsers: parses sections
- Section parsers → Image URL builders: builds image URLs
src/features/activities/parser.ts - Canvas page → Result page: opens result
README.md - Result page → Result template: renders
- Result template → README result: renders
- Localized app → Settings handle: registers handles