Installation

This guide will help you install and set up Trailmix CMS in your NestJS project.

Prerequisites

• Node.js (v24 or higher)
• NestJS application
• Clerk api keys
• MongoDB instance. MongoDB Atlas has a Free tier.

Installing Packages

Trailmix CMS is published as scoped packages under @trailmix-cms. Install the packages you need:

yarn add @trailmix-cms/cms @trailmix-cms/db @trailmix-cms/models @trailmix-cms/utils

Peer Dependencies

Make sure you have the required peer dependencies installed:

yarn add @nestjs/common @nestjs/core fastify mongodb nestjs-zod reflect-metadata rxjs zod

Vue Package (for frontend)

yarn add @trailmix-cms/vue

Next Steps

After installation, proceed to the Configuration guide to configure Trailmix CMS for your project.