Developing

Once you've created a project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

To have the whole stack backing your dev environment, 3 solutions:

1. Backend is run by docker

In the root folder:

docker build . -t windmill
docker-compose up db server

2. Backend is run by cargo

In the backend folder:

cargo run

In the root folder

docker-compose up db

In both cases

In the frontend folder:

sudo caddy run --config ./Caddyfile

(sudo is required to bind port 80 and 443)

and then go to http://localhost

Backend is run by remote!

sudo caddy run --config ./CaddyfileRemote

and then go to http://localhost

Building

npm run build

Generating the backend client automatically

npm run generate-backend-client

Formatting

This project uses prettier and prettier-plugin-svelte, be sure to install them and set up your editor to run prettier automatically before you commit.

Recommended config for VS Code:

Prettier for formatting
Svelte for VS Code for highlighting and Intellisense
make sure that your VS Code settings.json has the following lines:

"[svelte]": {
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    }

turn format on save on

1.6 KiB Raw Permalink Blame History