Skip to content

Commit eac8d0a

Browse files
feat: update README and package.json for improved local development setup
1 parent 059b91b commit eac8d0a

File tree

3 files changed

+12
-40
lines changed

3 files changed

+12
-40
lines changed

frontend/README.md

Lines changed: 10 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,56 +4,27 @@ The frontend is an Angular application that provides an interactive web interfac
44

55
## Development server
66

7-
To start a local development server, run:
7+
To start a local development server for the first time, run:
88

99
```bash
10-
ng serve
10+
just \
11+
install-api-client-deps \
12+
install-frontend-deps \
13+
run-frontend
1114
```
1215

1316
Once the server is running, open your browser and navigate to `http://localhost:4200/`. The application will automatically reload whenever you modify any of the source files.
1417

15-
## Code scaffolding
16-
17-
Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
18-
19-
```bash
20-
ng generate component component-name
21-
```
22-
23-
For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
18+
Subsequent runs can be started with:
2419

2520
```bash
26-
ng generate --help
21+
just run-frontend
2722
```
2823

29-
## Building
30-
31-
To build the project run:
24+
or
3225

3326
```bash
34-
ng build
27+
just run
3528
```
3629

37-
This will compile your project and store the build artifacts in the `dist/` directory. By default, the production build optimizes your application for performance and speed.
38-
39-
## Running unit tests
40-
41-
To execute unit tests with the [Vitest](https://vitest.dev/) test runner, use the following command:
42-
43-
```bash
44-
ng test
45-
```
46-
47-
## Running end-to-end tests
48-
49-
For end-to-end (e2e) testing, run:
50-
51-
```bash
52-
ng e2e
53-
```
54-
55-
Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
56-
57-
## Additional Resources
58-
59-
For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
30+
to start both the backend and frontend together.

frontend/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
"@angular/material": "~21.1.3",
3434
"@angular/platform-browser": "^21.1.0",
3535
"@angular/router": "^21.1.0",
36+
"@geoengine/biois": "file:../api-client/typescript",
3637
"rxjs": "~7.8.0",
3738
"tslib": "^2.3.0"
3839
},
@@ -43,7 +44,6 @@
4344
"@angular/material": "^21.1.3",
4445
"@fontsource/material-icons": "^5.2.7",
4546
"@fontsource/poppins": "^5.2.7",
46-
"@geoengine/biois": "file:../api-client/typescript",
4747
"@vitest/coverage-v8": "^4.0.18",
4848
"angular-eslint": "21.2.0",
4949
"eslint": "^9.39.2",

justfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ install-frontend-deps:
2727
@-clear
2828
rm -rf node_modules/@geoengine/biois \
2929
.angular/cache
30+
npm link ../api-client/typescript
3031
npm ci
3132

3233
[group('frontend')]

0 commit comments

Comments
 (0)