Skip to main content

Getting Started

Get started by instantiating a new site or starting an existing one.

What you'll need​

  • Node.js version 18.0 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.
  • Tmux (used to display client and backend in the same terminal).
  • pnpm for managing dependencies and starting the workspace.
  • VSCode: recommended editor. The project has some prebuilt configs.

🆕 Generate a new project​

You can use this repository as a template. This will create a new repository with this template files. Now, clone your new repository, and you are ready to go!

📦 Install dependencies​

In order to install all dependencies, in the project's root folder, run:

pnpm i

🔨 Build packages​

In order to install all dependencies, in the project's root folder, run:

pnpm build:packages

▶️ Start your site​

Start your app in development mode:

pnpm dev

If you want to start is as production mode, run:

pnpm prod