mirror of
https://github.com/windmill-labs/windmill.git
synced 2026-08-19 16:02:14 +00:00
Ruben Fiszel
89 lines
1.6 KiB
Markdown
89 lines
1.6 KiB
Markdown
# Developing
|
|
|
|
Once you've created a project and installed dependencies with `npm install` (or
|
|
`pnpm install` or `yarn`), start a development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
To have the whole stack backing your dev environment, 3 solutions:
|
|
|
|
### 1. Backend is run by docker
|
|
|
|
In the root folder:
|
|
|
|
```bash
|
|
docker build . -t windmill
|
|
docker-compose up db server
|
|
```
|
|
|
|
### 2. Backend is run by cargo
|
|
|
|
In the backend folder:
|
|
|
|
```bash
|
|
cargo run
|
|
```
|
|
|
|
In the root folder
|
|
|
|
```bash
|
|
docker-compose up db
|
|
```
|
|
|
|
### In both cases
|
|
|
|
In the frontend folder:
|
|
|
|
```bash
|
|
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!
|
|
|
|
```bash
|
|
sudo caddy run --config ./CaddyfileRemote
|
|
```
|
|
|
|
and then go to <http://localhost>
|
|
|
|
## Building
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
## Generating the backend client automatically
|
|
|
|
```bash
|
|
npm run generate-backend-client
|
|
```
|
|
|
|
## Formatting
|
|
|
|
This project uses [prettier](https://prettier.io/docs/en/install.html) and
|
|
[prettier-plugin-svelte](https://github.com/sveltejs/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](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
|
|
for formatting
|
|
- [Svelte for VS Code](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode)
|
|
for highlighting and Intellisense
|
|
- make sure that your VS Code `settings.json` has the following lines:
|
|
|
|
```json
|
|
"[svelte]": {
|
|
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
|
}
|
|
```
|
|
|
|
- turn _format on save_ on
|