Updated tutorial docs for spring integration. #521

EHandtkeBasis · 2025-08-27T15:11:29Z

No description provided.

MatthewHawkins

Overall, I'd make sure to deep link the heck out of all of this, whether that's to existing webforJ docs pages, or to outside info on Spring, Jakarta, etc.

Make sure that there's some cursory info given when you introduce a new spring concept.

MatthewHawkins · 2025-09-02T15:35:39Z

docs/docs/introduction/tutorial/overview.md

-To get the most out of this tutorial, it’s assumed that you have a basic understanding of Java programming and are familiar with tools like Maven. If you’re new to webforJ, don’t worry - the framework’s fundamentals will be covered along the way.

-The following tools/resources should be present on your development machine
+To get the most out of this tutorial, you should have a basic understanding of Java and Maven. No prior Spring Boot experience is required—key concepts will be introduced as needed.


Perhaps after mentioning that Spring Boot experience isn't overtly necessary, providing some reference material for those interested in the basics would be good.

MatthewHawkins · 2025-09-02T15:36:51Z

docs/docs/introduction/tutorial/project-setup.md


 To see the app in action at any stage:

 1) Navigate to the directory for the desired step. This should be the top level directory for that step, containing the `pom.xml`


Use consistent 1. or 1) throughout articles

MatthewHawkins · 2025-09-02T15:42:10Z

docs/docs/introduction/tutorial/creating-a-basic-app.md

-  @Override
-  public void run() throws WebforjException {
-    // App logic
+@SpringBootApplication


Should have at least a surface level explanation of the @SpringBootApplication annotation

MatthewHawkins · 2025-09-02T15:43:54Z

docs/docs/introduction/tutorial/creating-a-basic-app.md

+---

-### Adding CSS classes to components {#adding-css-classes-to-components}
+## 4. Configuration


Configuration section too brief - needs more Spring Boot, H2 and POM explanation, or at the very least deep linking to the appropriate articles.

MatthewHawkins · 2025-09-02T17:34:03Z

docs/docs/introduction/tutorial/creating-a-basic-app.md

-  public void run() throws WebforjException {
-    // App logic
+@SpringBootApplication
+@StyleSheet("ws://app.css")


Perhaps check with Hyyan here, but it may be a good idea to link the assets section here:

https://docs.webforj.com/docs/managing-resources/assets-protocols#the-webserver-protocol

MatthewHawkins · 2025-09-02T17:55:22Z

docs/docs/introduction/tutorial/working-with-data.md

  }

-  // Getter...
+  public SpringDataRepository<Customer, Long> getFilterableRepository() {


The SpringDataRepository wrapper needs more explanation

MatthewHawkins · 2025-09-02T18:04:32Z

docs/docs/introduction/tutorial/scaling-with-routing-and-composites.md

@@ -1,33 +1,111 @@
 ---


Looks like there's some fairly significant duplication here - you start around line 21 talking about routing, and then on line 110 you do the same thing, with similar content. Before I go over the rest of this, perhaps consolidate these two sections so I don't correct any stuff that you planned to remove anyway.

MatthewHawkins · 2025-09-02T18:10:08Z

docs/docs/introduction/tutorial/validating-and-binding-data.md

-    });
-    context.read(customer);
-  }
+public void onDidEnter(DidEnterEvent event, ParametersBag parameters) {


I would link this article for more info on did enter

MatthewHawkins · 2025-09-02T18:14:49Z

docs/docs/introduction/tutorial/validating-and-binding-data.md

-### Binding the fields {#binding-the-fields}

-The data binding setup begins with initializing a `BindingContext` for the `Customer` model. The `BindingContext` links the model properties to the form fields, enabling automatic data synchronization. This is set up in the `FormView` constructor.
+## Binding the fields


You link the auto binding section, but I'd add a link to the overview for data binding near the top that people can immediately go to for more info.

MatthewHawkins · 2025-09-02T18:15:46Z

docs/docs/introduction/tutorial/validating-and-binding-data.md

-## Validating data {#validating-data}

-Validation ensures that the data entered into the form adheres to specified rules, improving data quality and preventing invalid submissions. With data binding, validation no longer needs to be manually implemented but instead simply configured, allowing real-time feedback on user inputs.
+## Validating data


More info about the annotations used and potential other options would be good.

github-actions · 2025-09-03T09:23:54Z

docs/docs/introduction/tutorial/working-with-data.md

+This step adds data management and display capabilities to the demo app. You’ll define a `Customer` entity, use a Spring Data repository and service for data access, and display customer data in a [`Table`](../../components/table/overview) component.

-By the end of this step, the app created in the [previous step](./creating-a-basic-app) will display a table with the created data that can then be expanded on in the following steps. To run the app:
+This and all future steps utilize a H2 database. To use H2 with Spring Boot, add the H2 dependency to your pom.xml and set spring.datasource.url=jdbc:h2:mem:testdb in your application.properties. Spring Boot will auto-configure and start the H2 database for you.


⚠️ [vale] _{reported by reviewdog 🐶}
[webforJ.Simplify] Consider 'use' instead of 'utilize'.

github-actions · 2025-09-03T09:23:54Z

docs/docs/introduction/tutorial/working-with-data.md

+This step adds data management and display capabilities to the demo app. You’ll define a `Customer` entity, use a Spring Data repository and service for data access, and display customer data in a [`Table`](../../components/table/overview) component.

-By the end of this step, the app created in the [previous step](./creating-a-basic-app) will display a table with the created data that can then be expanded on in the following steps. To run the app:
+This and all future steps utilize a H2 database. To use H2 with Spring Boot, add the H2 dependency to your pom.xml and set spring.datasource.url=jdbc:h2:mem:testdb in your application.properties. Spring Boot will auto-configure and start the H2 database for you.


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.WordList] Use 'URL' instead of 'url'.

github-actions · 2025-09-03T09:23:54Z

docs/docs/introduction/tutorial/working-with-data.md

+This step adds data management and display capabilities to the demo app. You’ll define a `Customer` entity, use a Spring Data repository and service for data access, and display customer data in a [`Table`](../../components/table/overview) component.

-By the end of this step, the app created in the [previous step](./creating-a-basic-app) will display a table with the created data that can then be expanded on in the following steps. To run the app:
+This and all future steps utilize a H2 database. To use H2 with Spring Boot, add the H2 dependency to your pom.xml and set spring.datasource.url=jdbc:h2:mem:testdb in your application.properties. Spring Boot will auto-configure and start the H2 database for you.


⚠️ [vale] _{reported by reviewdog 🐶}
[Google.WordList] Use 'app' instead of 'application'.

Updated tutorial docs for spring integration.

26c75fb

EHandtkeBasis assigned MatthewHawkins and bbrennanbasis Aug 27, 2025

EHandtkeBasis requested review from MatthewHawkins, bbrennanbasis, hyyan, mschned and nmlynx as code owners August 27, 2025 15:11

EHandtkeBasis linked an issue Aug 27, 2025 that may be closed by this pull request

webforJ Tutorial refactor to use Spring #478

Open

Merge branch 'main' into tutorial-spring-integration

7986595

MatthewHawkins requested changes Sep 2, 2025

View reviewed changes

EHandtkeBasis added 2 commits September 3, 2025 10:12

Merge branch 'main' into tutorial-spring-integration

e945332

Addressed feedback.

4b0c06c

github-actions bot reviewed Sep 3, 2025

View reviewed changes

EHandtkeBasis added 2 commits September 3, 2025 11:26

fixed linting.

49cacf6

Merge branch 'main' into tutorial-spring-integration

c97dc0b

EHandtkeBasis requested a review from MatthewHawkins September 3, 2025 09:28

hyyan marked this pull request as draft October 16, 2025 06:16

hyyan added status: blocked Waiting on external dependency or details status: waiting-for-author Review is done. Waiting for the PR author to apply changes or respond. and removed status: blocked Waiting on external dependency or details labels Oct 27, 2025


		To see the app in action at any stage:

		1) Navigate to the directory for the desired step. This should be the top level directory for that step, containing the `pom.xml`

Uh oh!

Updated tutorial docs for spring integration. #521

Are you sure you want to change the base?

Updated tutorial docs for spring integration. #521

Uh oh!

Conversation

EHandtkeBasis commented Aug 27, 2025

Uh oh!

MatthewHawkins left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Sep 3, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants