How siddhant-pragyan-sinha/asyncapi-website works
Main Components
• Frontend Application: Represent the Next.js–based web app which includes:
• Pages (the “pages” folder that holds routes like /blog, /docs, /tools, etc.)
• UI Components (the “components” folder with reusable pieces like Buttons, Nav Bars, etc.)
• Context Providers (React contexts from the “context” folder)
• CSS styling (Tailwind CSS in “styles” and tailwind.config file)
• MDX integration and Storybook (the “.storybook” folder)
• Content & Data Sources:
• Markdown files (in “markdown” folder for blog posts, docs, tutorials, etc.)
• Config files (in “config” directory that hold JSON/YAML data for finance, case studies, etc.)
• Assets & Static Files (the “public” folder contains images, logos, translations, and SEO metadata)
• Build & Static Generation:
• Build Scripts (from the “scripts” folder that assembles blog posts, dashboards, and transforms markdown)
• Next.js build process (which outputs static pages to the “.next” folder)
• Serverless & Deployment Infrastructure:
• Netlify Functions (in the “netlify/functions” and “netlify/edge-functions” folders for dynamic processing, API integration, and schema fetching)
• Docker support (Dockerfile and related container configuration for local development and production)
• CI/CD Pipelines (GitHub workflows under “.github/workflows” that automate builds, testing, linting, and deployment)
Relationships & Data Flow
• How MDX/Markdown content (from the “markdown” folder) and configuration data (from “config”) feed into components via Next.js’s static generation.
• Data flow from imported assets and images (from “public”) to the rendered UI.
• Build Scripts perform pre-processing tasks (like converting markdown and generating RSS/blog lists) and then output data for Next.js to serve.
• Serverless functions on Netlify are invoked by the web app (or indirectly by proxy rules in netlify.toml) to handle dynamic content (for example, rewriting requests for JSON schema definitions).
• CI/CD Pipelines (via GitHub Actions) coordinate running tests, builds, and deployments (including Docker builds for local/production environments).
Architectural Patterns & Design Principles
• Static Site Generation / SSR: Show how Next.js consumes static and externally generated content and uses React components for dynamic interactivity.
• Separation of Concerns: The architecture clearly separates UI components, markdown content, configuration data, and backend serverless functions.
• CI/CD Automation: Emphasize the role of GitHub workflows and Netlify in automated testing, deployment, and edge function processing.
• Extensibility: The use of Storybook for component development and a modular component structure enables easy UI extension.
Relevant Technologies
• Next.js (React framework for SSR and static site generation)
• Tailwind CSS (for styling)
• Storybook (for UI workshop and documentation)
• Node.js & npm – for running build scripts, development server, and managing dependencies
• Docker (for containerized development/production)
• Netlify (for deployment, serverless functions, and edge functions)
• YAML, JSON, and Markdown as content and configuration formats
• Git and GitHub Actions for source control and CI/CD