> ## Documentation Index
> Fetch the complete documentation index at: https://www.nestjs-query.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

The `@ptc-org/nestjs-query-typegoose` package provides an implementation of `@ptc-org/nestjs-query-core` [QueryService](https://www.nestjs-query.dev/concepts/services.md).

This package is built using [typegoose](https://typegoose.github.io/typegoose/) and [nestjs-typegoose](https://github.com/kpfromer/nestjs-typegoose#readme). If you are unfamiliar with them I suggest you read their documentation first.

## Installation

[Installation Docs](https://www.nestjs-query.dev/introduction/install.md#ptc-orgnestjs-query-typegoose)

## Docs

* Read the [QueryService docs](https://www.nestjs-query.dev/persistence/services.md)
* [Relations](https://www.nestjs-query.dev/persistence/typegoose/relations.md) - How to work with relations/references in `typegoose` with `nestjs-query`
* [Custom Service](https://www.nestjs-query.dev/persistence/typegoose/custom-service.md) - Example custom service
* [Serialization](https://www.nestjs-query.dev/persistence/typegoose/serialization.md) - How to serialize `typegoose` models.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.