mirror of
https://gitlab.kit.edu/uskyk/typicalc.git
synced 2024-09-19 18:25:09 +00:00
58 lines
2.9 KiB
Markdown
58 lines
2.9 KiB
Markdown
# Typicalc
|
|
|
|
This is an example project that can be used as a starting point to create your own Vaadin application with Spring Boot.
|
|
It contains all the necessary configuration and some placeholder files to get you started.
|
|
|
|
The project is a standard Maven project, so you can import it to your IDE of choice. [Read more how to set up a development environment](https://vaadin.com/docs/v14/flow/installing/installing-overview.html) for Vaadin projects (Windows, Linux, macOS).
|
|
|
|
This project was created from https://start.vaadin.com.
|
|
|
|
## Running and debugging the applcation
|
|
|
|
### Running the application from the command line.
|
|
To run from the command line, use `mvn` and open http://localhost:8080 in your browser.
|
|
|
|
### Running and debugging the application in Intellij IDEA
|
|
- Locate the Application.java class in the Project view. It is in the src folder, under the main package's root.
|
|
- Right click on the Application class
|
|
- Select "Debug 'Application.main()'" from the list
|
|
|
|
After the application has started, you can view your it at http://localhost:8080/ in your browser.
|
|
You can now also attach break points in code for debugging purposes, by clicking next to a line number in any source file.
|
|
|
|
### Running and debugging the application in Eclipse
|
|
- Locate the Application.java class in the Package explorer. It is in `src/main/java`, under the main package.
|
|
- Right click on the file and select `Debug As` --> `Java Application`.
|
|
|
|
Do not worry if the debugger breaks at a `SilentExitException`. This is a Spring Boot feature and happens on every startup.
|
|
|
|
After the application has started, you can view your it at http://localhost:8080/ in your browser.
|
|
You can now also attach break points in code for debugging purposes, by clicking next to a line number in any source file.
|
|
## Project structure
|
|
|
|
- `MainView.java` in `src/main/java` contains the navigation setup. It uses [App Layout](https://vaadin.com/components/vaadin-app-layout).
|
|
- `views` package in `src/main/java` contains the server-side Java views of your application.
|
|
- `views` folder in `frontend/src/` contains the client-side JavaScript views of your application.
|
|
|
|
## What next?
|
|
|
|
[vaadin.com](https://vaadin.com) has lots of material to help you get you started:
|
|
|
|
- Follow the tutorials in [vaadin.com/tutorials](https://vaadin.com/tutorials). Especially [vaadin.com/tutorials/getting-started-with-flow](https://vaadin.com/tutorials/getting-started-with-flow) is good for getting a grasp of the basic Vaadin concepts.
|
|
- Read the documentation in [vaadin.com/docs](https://vaadin.com/docs).
|
|
- For a bigger Vaadin application example, check out the Full Stack App starter from [vaadin.com/start](https://vaadin.com/start).
|
|
|
|
## Deploying using Docker
|
|
|
|
To build the Dockerized version of the project, run
|
|
|
|
```
|
|
docker build . -t myapp:latest
|
|
```
|
|
|
|
Once the Docker image is correctly built, you can test it locally using
|
|
|
|
```
|
|
docker run -p 8080:8080 myapp:latest
|
|
```
|