Installation

System Requirements:

Node.js v20 or later.
macOS, Windows (including WSL), and Linux are supported.

Automatic Installation

To begin theme development, We recommend starting a new ContentQL app using create-cql-app, which sets up everything automatically for you. To create a project, run the following command in terminal:

npx create-cql-app@latest folderName

Note

By default folderName is undefined.

Run the Development Server

Run pnpm run dev to start the development server.
Visit http://localhost:3000 to view your application.
Click on Load demo data to load sample blog related data. Once loaded you'll see the following page:

Next Steps

Learn about the files and folders in your ContentQL project.

Project Structure

A list of folders and files in ContentQL project.