A template for creating or integrating a Croct project.

Introduction

This template adds Croct to an existing project or sets up a new Next.js project with Croct already integrated.

Usage

Run the following command to integrate Croct into an existing project:

npx croct@latest use croct://starter/croct

To specify a Next.js version, use the version option:

npx croct@latest use croct://starter/croct --version=14

Options

The following options are available for this template:

OptionDescriptionRequiredDefault
nameThe name of the project.Nomy-app
versionThe Next.js version to use.Nolatest
javascriptWhether to use JavaScript instead of TypeScript.Nofalse
tailwindWhether to use Tailwind CSS.Nofalse
eslintWhether to use ESLint.Notrue
turbopackWhether to use Turbopack.Nofalse
src-dirWhether to use a src directory.Nofalse
import-aliasThe import alias to use.No@/*
routerThe router to use (app or page).Noapp
disableLauncherWhether to disable the project launcher.Nofalse
defaultHomepageWhether to use the default homepage over Croct's.Nofalse
Explore or help us improve this template

Start building in seconds

Paste the following command in your terminal and let the CLI do the rest.

npx croct@latest use croct://starter