Get Started
Quick Start
Use the create-query-api CLI to scaffold a new @query-api/react 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)
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 React frontend.
Open your terminal and run the following command:
npx create-query-api@latest query-api-react --template react-vite
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/react-vite SDK into an existing React project or want to understand the setup process step by step, you can head over to the Manual Setup Guide