Skip to content

Commit

Permalink
Merge pull request #26 from vaadin/update-readme
Browse files Browse the repository at this point in the history
chore: Remove not relevant parts and unify introduction
  • Loading branch information
mshabarov authored Mar 20, 2024
2 parents 67a09f3 + 39d0b85 commit c2286b7
Showing 1 changed file with 2 additions and 28 deletions.
30 changes: 2 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# Flow-Hilla Hybrid Example

This project demonstrates how to use [Vaadin Flow](https://vaadin.com/flow) and [Hilla](https://hilla.dev) together in a single app.

[Hilla](https://hilla.dev/docs/react) is a framework by Vaadin for building reactive web applications on Java backends. It seamlessly integrates a [React](https://reactjs.org/) TypeScript frontend with a [Spring Boot](https://spring.io/projects/spring-boot) backend.
# Vaadin Hybrid Example

This project demonstrates how to build [Vaadin](https://vaadin.com) hybrid applications, i.e. server-side (Vaadin Flow) and frontend-side (Vaadin Hilla) views together in a single application.
The project uses [Spring-Boot Security](https://vaadin.com/docs/latest/security/enabling-security) to protect Flow and Hilla views.

## Running the Application
Expand Down Expand Up @@ -39,29 +36,6 @@ Integration tests are implemented using [Vaadin TestBench](https://vaadin.com/te

and make sure you have a valid TestBench license installed.

Profile `it` adds the following parameters to run integration tests:
```sh
-Dwebdriver.chrome.driver=path_to_driver
-Dcom.vaadin.testbench.Parameters.runLocally=chrome
```

If you would like to run a separate test make sure you have added these parameters to VM Options of JUnit run configuration

### Live Reload (optional)

With live reload, you can see the results of your code changes immediately.
When you edit your Java code and recompile it, the application changes will be automatically reloaded and the browser is refreshed.
This is done by leveraging [Spring Boot Developer Tools](https://docs.spring.io/spring-boot/docs/2.1.5.RELEASE/reference/html/using-boot-devtools.html).
To be able to see the changes in the browser tab, the page still needs to be reloaded.
That can also be automated via a LiveReload browser extension.
One such extension for Google Chrome is [LiveReload](https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei).
In Firefox, [LiveReload - Web extension](https://addons.mozilla.org/en-US/firefox/addon/livereload-web-extension/) can be used.
You can find such similar extensions for other major browsers too.
These extensions add an icon to your browser next to the address bar.
To enable the extension, you should click that icon after you opened your application.

You can find more information at [Live Reload in Spring Boot Applications](https://vaadin.com/docs/flow/workflow/tutorial-spring-boot-live-reload.html) document.

## Structure

Vaadin web applications are full-stack and include both client-side and server-side code in the same project.
Expand Down

0 comments on commit c2286b7

Please sign in to comment.