Guides

Directory Structure

├── bin
│   └── index.ts (main script to create admin user)
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── docker-compose.yml
├── Dockerfile
├── jest.config.ts
├── LICENSE
├── package.json
├── README.md
├── renovate.json
├── src
│   ├── app.ts (entry point of the application)
│   ├── controllers
│   │   ├── *.controller.ts (this file contain the main logic)
│   ├── middleware
│   │   ├── *.middleware.ts (this file contain reusable middleware)
│   ├── models
│   │   ├── *.model.ts (this file contain database collection schema/structure)
│   ├── routes
│   │   ├── *.routes.ts (this file contain all the routes related to particular category eg:- auth.routes.ts)
│   ├── schemas
│   │   ├── *.schema.ts (this file contain the validation for `request` using zod)
│   ├── services
│   │   ├── *.service.ts (this file contain logic for all the database related queries)
│   ├── tests
│   │   └── *.test.js (this file contain the tests)
│   ├── types
│   │   ├── enums.ts
│   │   ├── interfaces.ts
│   │   └── types.ts
│   └── utils
│   └── *.util.ts (this file contain reusable utility functions)
├── tsconfig.json
├── typedoc.json
└── yarn.lock

Jsdoc comments

We use Jsdoc to write documentation within the codebase

Remember to add these tags when you write your own Jsdoc comments

• functions

  • description
  • @author
  • @params
  • @example

• functions with generics

  • description
  • @author
  • @params
  • @typeParam
  • @example

• constants

  • description
  • @author
  • @constant