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: docker-init/README.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ $ docker compose -f docker-init/compose.yaml up
33
33
34
34
The **backend** is served at: http://localhost:9000
35
35
36
-
The **frontend** is served at: http://localhost:3000. This serves statically built code - no live dev server. `cd frontend; npm run dev` for a live dev server.
36
+
The **frontend** is served at: http://localhost:3000. This serves statically built code - no live dev server. `cd frontend; pnpm run dev` for a live dev server.
37
37
38
38
You can also access the parquet anomaly data table. To do so, from another terminal run:
Copy file name to clipboardExpand all lines: frontend/README.md
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ The frontend for Chronon.
7
7
### Prerequisites
8
8
9
9
-[Node.js](https://nodejs.org/en/) (LTS version recommended)
10
-
-npm (comes with Node.js)
10
+
-[pnpm](https://pnpm.io/installation) - fast and disk space efficient package manager
11
11
12
12
### Installation
13
13
@@ -26,7 +26,7 @@ The frontend for Chronon.
26
26
27
27
3. Install dependencies:
28
28
```bash
29
-
npm install
29
+
pnpm install
30
30
```
31
31
32
32
### Development
@@ -53,7 +53,7 @@ Done uploading summaries! 🥳
53
53
3. Then, start the development server:
54
54
55
55
```bash
56
-
npm run dev
56
+
pnpm dev
57
57
```
58
58
59
59
This will start a local server. The app will automatically reload if you make changes to the code.
@@ -63,7 +63,7 @@ This will start a local server. The app will automatically reload if you make ch
63
63
To create an optimized production build:
64
64
65
65
```bash
66
-
npm run build
66
+
pnpm build
67
67
```
68
68
69
69
This will create an optimized version of your project in the `build` directory.
@@ -73,7 +73,7 @@ This will create an optimized version of your project in the `build` directory.
73
73
To preview the production build locally:
74
74
75
75
```bash
76
-
npm run preview
76
+
pnpm preview
77
77
```
78
78
79
79
### Running Tests
@@ -85,72 +85,72 @@ npm run preview
85
85
To run both unit and integration tests together:
86
86
87
87
```bash
88
-
npm runtest
88
+
pnpmtest
89
89
```
90
90
91
91
#### Unit Tests
92
92
93
93
To run unit tests using Vitest:
94
94
95
95
```bash
96
-
npm run test:unit
96
+
pnpm test:unit
97
97
```
98
98
99
99
To run unit tests once:
100
100
101
101
```bash
102
-
npm run test:unit:once
102
+
pnpm test:unit:once
103
103
```
104
104
105
105
#### Integration Tests
106
106
107
107
To run integration tests using Playwright:
108
108
109
109
```bash
110
-
npm run test:integration
110
+
pnpm test:integration
111
111
```
112
112
113
113
To run integration tests once:
114
114
115
115
```bash
116
-
npm run test:integration:once
116
+
pnpm test:integration:once
117
117
```
118
118
119
119
For the Playwright UI to explore test results:
120
120
121
121
```bash
122
-
npm run test:integration:ui
122
+
pnpm test:integration:ui
123
123
```
124
124
125
125
### Linting and Formatting
126
126
127
127
To check code formatting and linting issues:
128
128
129
129
```bash
130
-
npm run lint
130
+
pnpm lint
131
131
```
132
132
133
133
To format the codebase:
134
134
135
135
```bash
136
-
npm run format
136
+
pnpm format
137
137
```
138
138
139
139
### Type Checking
140
140
141
141
To check the TypeScript types:
142
142
143
143
```bash
144
-
npm run check
144
+
pnpm check
145
145
```
146
146
147
147
To continuously check types while developing:
148
148
149
149
```bash
150
-
npm run check:watch
150
+
pnpm check:watch
151
151
```
152
152
153
153
## Best Practices
154
154
155
-
1.**Code Style**: This project uses Prettier and ESLint for code formatting and linting. Please run `npm run lint` and `npm run format` before committing changes.
155
+
1.**Code Style**: This project uses Prettier and ESLint for code formatting and linting. Please run `pnpm lint` and `pnpm format` before committing changes.
156
156
2.**Testing**: Ensure all changes are covered with unit and integration tests. Use Vitest for unit tests and Playwright for integration tests.
0 commit comments