Quick Start

Once you have installed the required dependencies for your system (see Prerequisites), you will be able to run the following command to build a Celaris Project.

QUICK START COMMAND

npm create celaris@latest <directory>

You can use qualified directory paths such as . or ../ if you wish here.

Setup Process

There are two stages to the setup process. The first requires minimal intervention. You will first be prompted to choose your framework of choice.

This will fetch a custom Vite template designed to interact with the Celaris backend to demonstrate basic functionality. You will then be asked if you wish to use TypeScript or not.

After selecting those options the build script will automate the rest of the process and will fetch the required templates and repositories to scaffold your application.

Run your app

To run your newly scaffolded project perform the following actions

cd <directory>
npm run celaris -- dev --no-build

NOTE

npm create celaris@latest runs a build command as part of the setup process. The build command is also baked into npm run celaris dev. Running the command above skips that second build on the first run. To enable it run the normal dev command

npm run celaris dev