Skip to content

Commit 70916b0

Browse files
authored
Document the main development commands (#201)
1 parent c86bed0 commit 70916b0

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,36 @@
22

33
This repository is an open-source example of how to quickly get up and running with Zoo's Text-to-CAD API endpoints. It is built using [SvelteKit](https://kit.svelte.dev/).
44

5-
To get started
5+
## Getting Started
66

7-
create a `.env.development.local` following `.env.development`
7+
Create `.env.development.local` copying `.env.development` as an example.
88

9-
then
9+
Run the local development server:
1010

1111
```bash
1212
yarn
1313
yarn dev
1414
```
15+
16+
## Validating Changes
17+
18+
Run static analysis:
19+
20+
```bash
21+
yarn fmt
22+
yarn check
23+
yarn lint
24+
```
25+
26+
Run unit tests:
27+
28+
```bash
29+
yarn test:unit
30+
```
31+
32+
Run end-to-end tests:
33+
34+
```bash
35+
yarn playwright install
36+
yarn test:e2e
37+
```

0 commit comments

Comments
 (0)