DEVELOPMENT_NOTES.md 1.2 KB

Project Development Notes

Package Manager

This project uses pnpm as the package manager. Always use pnpm commands instead of npm or yarn.

  • Install dependencies: pnpm install
  • Run scripts: pnpm run <script>
  • Add packages: pnpm add <package>

Development Servers

The web and service applications support hot reloading for most changes:

  • Web app (apps/web): Runs with pnpm run dev and hot reloads on code changes.
  • Service app (apps/service): Runs with pnpm run service and hot reloads on code changes.

Do not frequently stop and restart these servers unless necessary (e.g., for configuration changes or dependency updates). Let the hot reloading handle code updates during development.

Project Structure

  • Monorepo managed with Turbo
  • Apps: apps/web (Next.js), apps/service (NestJS)
  • Shared packages in packages/
  • Legacy code in legacy/

Running the Project

  • Full stack: pnpm run dev (runs both web and service)
  • Individual apps: pnpm run web or pnpm run service
  • With Docker: Use docker-compose.yml for containerized setup

Important Reminders

  • Use pnpm, not npm
  • Trust hot reloading - avoid unnecessary restarts
  • Check package.json scripts for available commands