Skip to content

Commit

Permalink
more installstion steps in README.md, vscode settings, script to open…
Browse files Browse the repository at this point in the history
… chrome
  • Loading branch information
hofiorg committed Nov 16, 2024
1 parent 8c00ec5 commit 787f095
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 10 deletions.
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"java.compile.nullAnalysis.mode": "disabled"
}
44 changes: 34 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,23 @@ nvm use lts/iron
npm install -g @angular/cli
```

### Install Java

#### Installation with Homebrew (MacOS)

```sh
brew install openjdk
sudo ln -sfn $HOMEBREW_PREFIX/opt/openjdk/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk
```

### Install Maven

#### Installation with Homebrew (MacOS)

```sh
brew install maven
```

### Scripts directory

All development scripts can be found under
Expand All @@ -37,55 +54,63 @@ Run `01_install_fe.sh` to install the JavaScript project. This runs `npm install

```sh
01_install_fe.sh
```
```

## Development server

Run `02_start_fe_dev_server.sh` for a frontend development server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.

```sh
02_start_fe_dev_server.sh
```
```

## Running unit tests

Run `03_test_fe.sh` to execute the frontend unit tests via [Karma](https://karma-runner.github.io).

```sh
03_test_fe.sh
```
```

## Install Server

Run `10_install_server.sh` to install the server project. This runs `mvn clean install`.

```sh
10_install_server.sh
```
```

## Test Server

Run `11_test_server.sh` to test the server project. This runs `mvn test`.

```sh
11_test_server.sh
```
```

## Build

Run `20_build.sh` to build the project. The build artifacts will be stored in the `target/` directory.

```sh
20_build.sh
```
```

## Start

Run `30_start_server.sh` to start the Spring Boot server with Java.

```sh
30_start_server.sh
```
```

## Open in Chrome

Run `40_open_chrome.sh` to start Chrome.

```sh
40_open_chrome.sh
```

## Code scaffolding

Expand Down Expand Up @@ -161,15 +186,14 @@ ng add @ngrx/effects@latest
- Login with OAuth
- Example:
- <https://www.baeldung.com/rest-api-spring-oauth2-angular>
- OAuth - https://github.com/manfredsteyer/angular-oauth2-oidc
- OAuth - <https://github.com/manfredsteyer/angular-oauth2-oidc>
- Table filter for columns
- Example:
- <https://www.w3schools.com/howto/howto_js_filter_table.asp>
- Table actions for edit/delete/etc.
- Website navigation
- Examples:
- Examples:
- <https://dev.to/davidihl/how-to-create-a-responsive-sidebar-and-mini-navigation-with-material-angular-o5l>
- <https://medium.com/@ahmedaabouzied/angular-material-responsive-navigation-53b573305d3d>
- <https://medium.com/@vperviz/create-an-angular-app-with-a-side-navigation-and-a-dashboard-in-5-minutes-with-schematics-300fc3b8e0a8>
- Routing with IDs for detail views

1 change: 1 addition & 0 deletions src/main/scripts/40_open_chrome.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
open -a "Google Chrome" http://localhost:8080

0 comments on commit 787f095

Please sign in to comment.