This project was created from https://start.vaadin.com. It's a fully working Vaadin application that you continue developing locally. It has all the necessary dependencies and files to help you get going.
The project is a standard Maven project, so you can import it to your IDE of choice. You'll need to have Java 8+ and Node.js 10+ installed.
To run from the command line, use mvn and open http://localhost:8080 in your browser.
| Directory | Description |
|---|---|
frontend/ |
Client-side source directory |
index.html |
HTML template |
index.ts |
Frontend entrypoint, contains the client-side routing setup using Vaadin Router |
main-layout.ts |
Main layout Web Component, contains the navigation menu, uses App Layout |
views/ |
UI views Web Components (TypeScript) |
styles/ |
Styles directory (CSS) |
src/main/java/<groupId>/ |
Server-side source directory, contains the server-side Java views |
Application.java |
Server entrypoint |
vaadin.com has lots of material to help you get you started:
- Read the Quick Start Guide to learn the first steps of full stack Vaadin applications development.
- Follow the tutorials in vaadin.com/learn/tutorials. Especially Building Modern Web Apps with Spring Boot and Vaadin is good for getting a grasp of the basic Vaadin concepts.
- Read the documentation in vaadin.com/docs.
- For a bigger Vaadin application example, check out the Full Stack App starter from vaadin.com/start.
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