How gitroll-dev/gitroll-profile-card works
Project type and purpose
• This is a frontend component library, specifically a React/TypeScript “Profile Card” component that can be embedded or previewed via an online playground. It’s packaged with Vite and Storybook, and deployed as a static site (GitHub Pages) for live previews.
File structure
• Top-level files and folders:
• .github/workflows: CI/CD pipelines (commit previews, PR previews, deploy to Pages, releases)
• .changeset: Change management for releases
• .storybook: Storybook configuration (main.ts, preview.ts)
• public: static assets for the playground and demo
• scripts/generate.ts: auxiliary scripts (e.g., theme or asset generation)
• src: source code of the card component (OGCard.tsx, decorations.tsx, theme.ts, rating.ts, logo.tsx, index.ts) plus stories and CSS
• index.html, vite.config.ts, tsconfig.json: Vite dev and build configuration
• Patterns and conventions:
• src/index.ts exports component for npm consumption
• src/main.tsx + index.html bootstraps the playground app with HMR
• Storybook for isolated component development
• CI workflows automate previews and deployments
README for additional insights
• Describes preset themes, how to run the local dev server (pnpm dev), how to preview in the online playground, and how to contribute themes.
• Mentions HMR, theme query-params, and playground customization.
Final recommendation
• Be detailed: capture every major flow (dev → preview → release → consumption).