You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.MD
+2-13Lines changed: 2 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,6 @@
2
2
3
3
Thank you for your interest in contributing! This document explains how to set up your environment, make changes safely, and submit high‑quality pull requests.
4
4
5
-
6
5
## Prerequisites
7
6
8
7
- Node.js (see .nvmrc file)
@@ -16,7 +15,6 @@ pnpm install
16
15
pnpm prepare # installs Husky if hooks are present
17
16
```
18
17
19
-
20
18
## Development workflow
21
19
22
20
- Start the dev server: `pnpm dev`
@@ -27,7 +25,6 @@ pnpm prepare # installs Husky if hooks are present
27
25
28
26
Build output goes to `web/` and should not be edited directly.
29
27
30
-
31
28
## Environment configuration
32
29
33
30
We use Vite modes and `.env.*` files. You can `cp .env.local.example .env.local` to get started fast.
@@ -42,7 +39,6 @@ Some commonly used variables:
42
39
43
40
See `.env.prod` for a production example. For local development, create `.env.local` based on `.env.local.example`.
44
41
45
-
46
42
## Commit conventions
47
43
48
44
We use Conventional Commits and commitlint to keep history clean and to power semantic-release.
- Package manager: pnpm (see package.json `packageManager`)
10
10
11
-
12
11
## Quick start (develop this repo)
13
12
14
13
Prerequisites:
14
+
15
15
- Node.js (see .nvmrc)
16
16
- pnpm (the version in `package.json#packageManager` is recommended)
17
17
@@ -27,17 +27,18 @@ pnpm dev:local
27
27
Builds are emitted to `web/` (see `vite.config.ts`). The `web/` directory is build output; don’t edit it by hand.
28
28
29
29
Common scripts:
30
+
30
31
-`pnpm dev` — start Vite dev server
31
32
-`pnpm dev:local` — start in Local Studio mode
32
33
-`pnpm build` — type-check then build for production
33
34
-`pnpm build:dev|stage|prod|local` — build for a specific mode
34
35
-`pnpm preview` — serve the built `web/`
35
36
-`pnpm test` / `pnpm test:watch` — run unit tests (Vitest)
36
-
-`pnpm lint` — run ESLint
37
+
-`pnpm lint` — run code linting (use `pnpm lint:fix` to write changes)
38
+
-`pnpm format` — check formatting of code (use `pnpm format:fix` to write changes)
37
39
38
40
Tip: prefer using the Makefile shortcuts in `Makefile` if you like `make` (e.g. `make dev`, `make build-prod`).
39
41
40
-
41
42
## Using this app via Harper (Local Studio)
42
43
43
44
If you would like to run the Studio UI locally via Harper itself, install and start Harper with Local Studio enabled. At runtime, Harper will serve the compiled UI from this repository.
@@ -46,12 +47,11 @@ Open your harperdb-config.yaml and enable localStudio:
46
47
47
48
```yaml
48
49
localStudio:
49
-
enabled: true
50
+
enabled: true
50
51
```
51
52
52
53
Then visit http://localhost:9925 (or wherever you've set your operations port) to access the Local Studio. The default dev URL used by this repo is `http://localhost:9925` (see `VITE_LOCAL_STUDIO_DEV_URL`).
53
54
54
-
55
55
## Environments and configuration
56
56
57
57
This project uses Vite environment files and modes. You can pass `--mode <name>` to Vite to pick a `.env.<name>` file. Some keys you may encounter:
@@ -72,10 +72,10 @@ VITE_ENV_NAME=dev
72
72
```
73
73
74
74
Notes:
75
+
75
76
- A production example is in `.env.prod`.
76
77
- Building for a specific environment uses the matching mode: `pnpm build:dev`, `pnpm build:stage`, or `pnpm build:prod`.
77
78
78
-
79
79
## OpenAPI SDK generation
80
80
81
81
This repository can generate TypeScript definitions from the Central Manager OpenAPI schema.
0 commit comments