Skip to content

Latest commit

 

History

History
147 lines (100 loc) · 3.33 KB

README_DEV.md

File metadata and controls

147 lines (100 loc) · 3.33 KB
Raw

Developing

Starting The Development Server

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 windmill_server windmill_worker

2. Backend is run by cargo

Prerequisites

  • Install Rust as explained on the website.

  • Install llvm

    On OSX:

    brew install llvm caddy gsed

# make LLVM tools available on PATH
echo 'export PATH="/opt/homebrew/opt/llvm/bin:$PATH"' >> ~/.zshrc

# now, restart your shell. You should now have the `lld` binary on your PATH.

  • To test that you have Rust and Cargo installed run cargo --version

  • In your terminal, go to the backend directory and run cargo build

  • Run cargo run

Known issue on M1 Mac while running cargo build

  • You may encounter linking with cc failed build time error.
  • To solve this run: 
    echo 'export RUSTFLAGS="-L/opt/homebrew/opt/libomp/lib"' >> ~/.zshrc
source ~/.zshrc

Do a Frontend Build

In order to run the backend, you need to have a frontend build inside frontend/build/.

Otherwise, cargo run will break.

So, in the frontend folder, run:

# !!! on OSX, you are not allowed to use the system SED, but you need to use GNU SED.
# !!! thus, in `frontend/package.json`, replace all `sed` occurences with `gsed`.

# prerequisite for build
npm run generate-backend-client

npm run build
# now, you'll have a `frontend/build` folder.

Known issue while running npm run build

  • You may encounter FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory error.
  • To solve this run:
export NODE_OPTIONS=--max_old_space_size=8096
  • run npm run build again

In the root folder:

docker-compose up db

In the backend folder:

DATABASE_URL=postgres://postgres:[email protected]:5433/windmill?sslmode=disable cargo run

You can now access http://127.0.0.1:8000.

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

3. 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