How sato-seminor/seminar-website works
Project type and purpose
• Project type: A frontend-only, static Next.js website built with TypeScript, React, Tailwind CSS, and shadcn/ui.
• Purpose: Serve as the official homepage for Sato Seminar, deployed as a static site on GitHub Pages.
File structure
Top-level highlights:
• Configuration files: next.config.ts, tsconfig.json, postcss.config.mjs, tailwind.config.ts
• Dev tools: .devcontainer, .github/workflows/deploy.yml, Husky hooks, ESLint/Prettier configs, lint-staged
• Source code: src/app (Next.js App Router pages), src/components (shared UI pieces), src/features (feature-scoped UI + data), src/lib (utility code), src/styles
Patterns & choices:
• App Router: src/app folder for route-based pages with layout.tsx and nested routes (about, activities, selection).
• “Feature” subdirs group domain logic (UI + static data).
• “components/ui” holds atomic UI components; “components/layout” holds global UI (navigation, theme toggle).
• No runtime backend or database – it’s pre-rendered static content.
README for additional insights
• Confirms tech stack: Next.js (App Router), TypeScript, Tailwind, shadcn/ui
• CI/CD: GitHub Actions builds and deploys to GitHub Pages
• Dev Container ensures a reproducible developer environment
Main components & relationships
A. Developer Environment
– VS Code (Dev Container)
– Git hooks (Husky, lint-staged), ESLint/Prettier
B. Source Code
– Next.js App (src/app, src/components, src/features, src/lib)
– Styling: Tailwind CSS, postcss
– UI Library: shadcn/ui components
C. Version Control & CI/CD
– GitHub (repo)
– GitHub Actions workflow (build → static export)
D. Hosting & Delivery
– GitHub Pages (static hosting)
– CDN (optional, GitHub Pages caching)
– End-user browsers (HTTP(S) requests)
Data flow / interactions:
1. Developer writes code in Dev Container → commits to GitHub
2. GitHub Actions triggers on push → runs lint/tests → next build → next export
3. Artifacts deployed to GitHub Pages
4. User’s browser requests HTML/CSS/JS from GitHub Pages CDN → static page render
Architectural patterns & principles
– Separation of concerns:
• App routes vs. shared UI vs. feature-scoped modules
– Static Site Generation (SSG): no backend, all pages pre-rendered
– Component-driven development: atomic UI in components/ui, layout in components/layout, domain features in features/*
– CI/CD best practices: automated linting, format, build, and deploy
Detail without over-thinking
– Capture every major folder as a sub-component (App Router, UI library, features, lib)
– Show build-time rendering step (Next.js build & export)
– Don’t forget code-quality tools in the developer flow (Husky, ESLint, Prettier, lint-staged)