How forif-npo/forif-official works
Project Type and Purpose
• This project is the official website for Hanyang University’s largest academic programming club (“FORIF-OFFICIAL”). It consists of two main applications – an Admin portal and a User-oriented website – that share common component libraries and utilities.
• The README outlines font style guidelines, suggesting that typography and consistent UI design are important. The website likely displays information-rich pages with clearly defined text presentation (display, headline, title, body, label).
Key Components Identified from the File Tree
• Administrative App (apps/admin): Contains routes for dashboard, posts, studies, members, authentication, and common UI components such as AppBar and SideBar.
• User App (apps/user): Contains routes for announcements, applications, club information, FAQ, hackathon details, studies, tech-blog, and UI components such as AppBar, error pages, and profile.
• Shared Component Library (packages/components): A reusable library of UI components including common elements (Button, Input, Modal, etc.), form components, and table components.
• Shared Constants and Configuration (packages/constants, packages/ts-config, .eslintrc, .prettierrc, etc.): These files govern global code formatting, standards, and TypeScript configurations.
• GitHub Workflows & Scripts: Contains CI/CD configurations for deployment, inspections, and push events.
• Testing and Build Tools: While not explicitly diagrammed, note that configuration files such as pnpm-workspace.yaml and package.json at the root highlight that this is a monorepo with multiple packages and apps.
Relationships and Interactions
• Each application has its own routing structure, service layers, and state management (stores), which interact with the UI layer.
Architectural Patterns and Design Principles
• The separation into apps (admin and user) points to a multi-application, monorepo architecture.
• Both apps follow a component-based architecture (React with TypeScript) and emphasize proper UI abstraction by reusing common UI components from packages/components.
• The structure of routes and services in the apps suggests adherence to design patterns like MVC (Model-View-Controller) – where routes/pages (views) interact with services (controllers and models) and state stores.
• Usage of tools for code consistency (e.g., ESLint, Prettier) and CI/CD workflows reflects good DevOps practices integrated into the project architecture.