How dnd-side-project/dnd-12th-9-frontend works
Project Type and Purpose
• The project is a full-stack monorepo primarily built with Next.js (evident through files like next.config.mjs, middleware.ts, and the “app” directory structure under apps/web).
• It functions as a reading record service (Sbooky) featuring book management, user profiles, onboarding, and reward systems.
• The service emphasizes a rich, component-driven UI, with a dedicated Storybook app under apps/storybook for UI development and design validation.
File Structure
• The project uses a monorepo arrangement with multiple “apps” (web application and storybook) and shared “packages” (ui components, eslint-config, tailwind-config, typescript-config). This hints at a modular architecture where design systems and utility configurations are centrally managed.
• Within apps/web, the “app” folder is arranged into feature modules such as _api, auth, books, closet, home, mission, profile, search, and store. This reflects a domain-driven design, with feature-specific folders handling routes, API services, and UI components.
• Numerous configuration files (e.g., for ESLint, Tailwind, Prettier, pnpm, and Turbo) along with GitHub workflows and CI/CD pipelines support an automated build, lint, and deployment process.
README for Additional Insights
• The README describes Sbooky as a “독서 기록 서비스” with attractive visuals and features geared towards enhancing the reading experience.
• The development description mentions integrations with external analytics (Clarity, GA, Vercel Analytics) and search engine optimization (Sitemap, robots.txt, meta tags, search console). These are important for understanding external dependencies and integrations.
• The visuals in the README (UI addbooks, UI review, UI rewards, etc.) suggest that the UI and interactive components are a core aspect of the project.
a. Main Components to Include:
• Client (Browser/Device): Represents the end-user interacting with the front-end.
• Frontend Web Application (apps/web): Built on Next.js, including server-side routes, API endpoints (/_api), and page-specific modules (auth, books, home, etc.).
• UI Component Library (packages/ui): A shared library that contributes to the consistent look and feel across the interface.
• Storybook Environment (apps/storybook): A separate application for developing and testing UI components.
• Development & Configuration Tools: Include shared packages (eslint-config, tailwind-config, typescript-config) and CI/CD pipelines (GitHub workflows).
• External Services: Analytics (Clarity, Google Analytics, Vercel Analytics), SEO tools (Search Console integrations), and possibly authentication services based on API endpoints.
b. Relationships and Interactions:
• The browser interacts with the frontend web application. Frontend components call internal API routes (/_api) for data operations.
• The UI component library is utilized by both the web application and the Storybook environment.
• CI/CD services orchestrate deployment, code linting, testing, and Storybook previews, ensuring that code updates propagate smoothly across the system.
• External services integration (analytics, SEO) are connected to the web application via embedded scripts or API integrations.
c. Architectural Patterns and Design Principles:
• Monorepo Architecture: Consolidates multiple applications and shared libraries into a single workspace (managed by pnpm and Turbo).
• Modular / Domain-Driven Design: Apps/web is subdivided by features (books, home, profile, etc.), each with dedicated API and UI components.
• Component-Driven UI: A detailed and reusable UI system sourced from “packages/ui” supports consistency and ease of updates.
• CI/CD & Automated Workflows: Continuous integration is handled within the .github/workflows directory to enable smooth automated testing and deployment.
d. Relevant Technologies and Frameworks:
• Next.js (for SSR, routing, middleware, and API endpoints)
• React (component-based architecture)
• Tailwind CSS (styling, with shared configuration in packages/tailwind-config)
• Storybook (for UI component development and visual testing)
• Analytics solutions (Clarity, GA, Vercel Analytics)
• pnpm and Turbo (for workspace management and orchestration)