Skip to content

Development

This project is built with NestJS, a progressive Node.js framework for building efficient, scalable server-side applications using TypeScript.

Documentation with Compodoc

Compodoc provides a comprehensive overview of the codebase, including:

  • Modules
  • Controllers
  • Services
  • DTOs
  • Dependencies
pnpm run compodoc:start

A rendered version of the build is included here.

Source Code Structure

Each module typically contains its own:

  • controller.ts — API endpoints
  • service.ts — Business logic
  • dto/ — Data Transfer Objects
  • entities/ — TypeORM entities (if needed)

Scripts

Useful development scripts:

pnpm run start:dev        # Start the app in watch mode
pnpm run test             # Run unit tests
pnpm run compodoc         # Generate Compodoc documentation
pnpm run compodoc:serve   # Serve the generated docs locally

💡 Compodoc output is stored in the doc/compodoc folder and served statically by the application.

Contributions

Feel free to contribute by improving documentation, fixing bugs, or extending functionality. Make sure to follow the coding standards and write tests where applicable.