Skip to main content

Quickstart

To create a new project, run the following command:

npx @kottster/cli@latest new

Make sure you have Node.js (v20 or above) installed on your system.

After running the command, the CLI will create a folder with your project name and install the required dependencies. If you want to create a project in a current folder, run npx @kottster/cli new . instead.

After installatinon is complete, change the directory to the project folder:

cd <project-name>

Development server

Now you can start the development server with the following command:

npm run dev

This will start the server on http://localhost:5480 or a different port if 5480 is already in use.

Alternative installation using Docker

If you prefer using Docker, please refer to the Docker quickstart guide.

Next steps

Now that you have your project up and running, you can start building your app: