How gnu-connect/server-node works
Project type and purpose
• This is a backend service built with NestJS (Node.js + TypeScript) that powers a KakaoTalk chatbot for Gyeongsang National University students.
• It exposes HTTP endpoints consumed by the Kakao i Open Builder frontend, scrapes external university systems for notices, dining menus, academic calendars, and library seat data, and persists results in a relational database and object storage.
File structure
• Top-level folders and files
• Dockerfile, docker-compose.yml/dev: container definitions for local/dev and production environments.
• .github/workflows/ci-cd pipeline.yml: CI/CD automation.
• src/
– api/common: shared decorators, DTOs, filters, interceptors, utilities.
– api/internal: health-check module.
– api/public: feature modules (campuses, colleges, departments, message-templates, reading-rooms, users) each following NestJS’s controller → service → module pattern.
– type-orm: database module, entity definitions, custom repositories.
– main.ts & instrument.ts: application bootstrap and telemetry setup.
• test/: end-to-end tests.
• Configuration files for ESLint, Prettier, TypeScript, Nest CLI, PNPM lock.
README for additional insights
• Technology stack includes NestJS, TypeORM (PostgreSQL), Redis (caching), Supabase Storage (for screenshots), Docker, GCP, Sentry for monitoring.
Details
• Essential modules (common, internal, public) and their interactions.
• Surface cross-cutting concerns like logging/monitoring and environment configuration.
• Don’t omit background jobs or caching layers—they’re critical to system behavior.