Getting Started
Installation
Get Lyrix up and running in your Next.js project in under 5 minutes.
Requirements
Lyrix requires Node.js 18+, Next.js 14+ with App Router, and TypeScript (recommended).
Create a new Lyrix project
The fastest way to get started is using the Lyrix CLI scaffolder. This sets up a full Next.js project with Lyrix pre-configured.
bash
npx create-lyrix-app my-project
cd my-project
npm run devAdd to an existing project
You can also install Lyrix into an existing Next.js app manually.
bash
npm install @lyrix/core @lyrix/renderer