Quick Start

Before beginning, you will need Node.js version 22.12.0 or higher installed.

Scaffold a New Project (Recommended) #

The fastest way to get started is by using the create-coralite CLI tool to scaffold a new project template.

Install via Package Manager #

  npm create coralite@latest

Alternatively, use other package managers:

  yarn create coralite

  pnpm create coralite

Note: The create-coralite CLI is also registered as cca (short for Coralite Create App).

CLI Options #

-o, --output #

Set the project output directory.

  npm create coralite -o my-project

-t, --template #

Select styling template for the scaffolded project (Choices: css, scss).

  npm create coralite -t scss

Manual Installation #

Alternatively, after initialising your project, install coralite as a dev dependency:

  npm install coralite

Build script #

To prepare the development environment, we'll add the build command to the "script" property in our package.json file.

Here is an example of what your package.json file should look like:

For more information about the CLI options check out the CLI reference page.

  {
    "name": "my-coralite-site",
    "scripts": {
      "build": "coralite -c src/components -p src/pages -o dist"
    },
    "dependencies": {
      "coralite": "^0.28.5"
    }
  }

Next, follow the getting started tutorial to discover how build your first web page with Coralite!