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 projectName

Note

By default projectName is undefined.

Run the Development Server

Things to do

Ensure your project is open in your code editor before running the development server. Create a .env file at the project root and copy the contents from .env.example.
Two main template customization configurations: Storage and Emails.
- For storage, we use S3. If you have S3-compatible storage with documented details in .env, proceed.
- Resend is a free email API service with 100 emails per day. Visit resend to create an account and get email keys for your templates.

Open your project folder and type 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.