> For the complete documentation index, see [llms.txt](https://voyzu.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://voyzu.gitbook.io/docs/other-voyzu-packages/voyzu-ice-creams.md).

# @voyzu/ice-creams

`@voyzu/ice-creams` is the best-practice reference package for Voyzu package development. It is intentionally small enough to understand while demonstrating the normal structure of a production package.

It includes:

* Package and module declarations with package-owned top and left navigation.
* Layered CRUD pages and REST APIs using Voyzu DTO, validation, service and repository patterns.
* Database installation, reference seeds, optional sample data and uninstall artifacts.
* Audited business data, package-owned audit views and the shared platform audit API.
* A report module with interactive and printable routes.

Use this package as a working example when following [Develop a new package](/docs/voyzu-platform-guide/develop-a-new-package.md), the [package contract](/docs/voyzu-platform-guide/package-contract.md) and the [module contract](/docs/voyzu-platform-guide/module-contract.md).

## Install

```shell
npm run voyzu:install -- https://github.com/chrisjameslennon/voyzu-packages.git @voyzu/ice-creams
```

[View the source on GitHub](https://github.com/chrisjameslennon/voyzu-packages/tree/main/packages/%40voyzu/ice-creams).