Get Started
Quick Start
Use the create-query-api CLI to scaffold a new @query-api/nuxt project.
Requirements
- The Craft Query API plugin must be installed and properly configured in Craft CMS.
- Node.js - 20.x or newer (but I recommend the active LTS release)
- Nuxt > 3 is required (Nuxt 4 is already supported).
Installation
The fastest way to get started is with the create-query-api command-line tool. It scaffolds a complete project for you, including a pre-configured Craft CMS and a Nuxt frontend.
Open your terminal and run the following command:
npx create-query-api@latest query-api-nuxt --template nuxt
Note
You can log into the control panel with these credentials:
- Username:
admin - Password:
admin123
Manual Installation
If you want to integrate the @query-api/nuxt SDK into an existing Nuxt project or want to understand the setup process step by step, you can head over to the Manual Setup Guide