How binarystudioacademy/bsa-2024-gitfit works
Project type and purpose
• This is a full-stack monorepo managed with npm workspaces.
• Frontend: React + Redux Toolkit SPA under apps/frontend
• Backend: Fastify REST API with TypeScript, Knex, Objection under apps/backend
• Shared package: TypeScript/Zod DTOs and helpers under packages/shared
• Analytics script: standalone Node CLI/cron job under scripts/analytics
• Purpose: collect Git commit data (activity logs), manage users/projects/groups/permissions, and display analytics
File structure
• Top level: apps/, packages/, scripts/, CI/CD configs (.github/), tooling
• apps/backend:
• db/migrations (PostgreSQL schema)
• src/libs: framework modules (config, http, logger, encryption, token, task-scheduler, server-app)
• src/modules: feature-by-feature (auth, users, projects, permissions, groups, project-groups, project-permissions, project-api-keys, contributors, git-emails, activity-logs, notifications, auth-analytics)
• Controller → Service → Repository → Model → Database flow
• apps/frontend:
• src/libs: shared React components, hooks, helpers, modules (api, config, http, storage, store, toast-notifier)
• src/modules: per-feature API clients + Redux slices
• src/pages: page compositions
• packages/shared: universal DTOs, Zod schemas, helpers used by both frontend and backend
• scripts/analytics: cron-based CLI that uses the shared API client to pull data from backend and generate reports
README for additional insights
• Technology stack: TypeScript, npm workspaces, React, Redux, Fastify, Knex, Objection, Zod
• Folder structure guidelines for frontend and backend