add Java Spring with Kendo Angular app #4420
Conversation
| 1. Clone this repository by running the following command: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/telerik/kendo-angular/.git | ||
| git clone https://github.com/telerik/kendo-angular/ | ||
| ``` | ||
|
|
||
| 1. Make sure to have the [.NET Core 8 SDK](https://dotnet.microsoft.com/download) installed on your machine, along with [Angular CLI 18.0.6](https://v17.angular.io/guide/setup-local#install-the-angular-cli). |
There was a problem hiding this comment.
is the file name intentionally with lowercase letters (readme.md)? In most repos the file is README.md.
Also valid for the file for the java integration.
| ## Development server | ||
|
|
||
| Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files. |
There was a problem hiding this comment.
Might need npm install command to be mentioned as well.
There was a problem hiding this comment.
The main README instructions are enough and the generated one by Angular can stay without changes.
|
|
||
| Follow these steps to set up and run the project locally: | ||
|
|
||
| ### 1. Install Required Tools |
There was a problem hiding this comment.
This might be better named Prerequisites and without the number at the front.
| ## Getting Started | ||
|
|
||
| Follow these steps to set up and run the project locally: |
There was a problem hiding this comment.
This looks unnecessary. We can remove it and make the below heading from H3 to H2 (prerequisites, clone the repo, etc.)
| Ensure you have the following tools installed on your machine: | ||
|
|
||
| - **Angular CLI (18.0.0 or later)**: A command-line interface for Angular. [Download Angular CLI](https://angular.io/cli). | ||
| - **Java Development Kit (JDK 23)**: Essential for running Java applications. [Download JDK](https://www.oracle.com/java/technologies/downloads/). |
There was a problem hiding this comment.
I have no clue which one should be installed:
Pointing the user to the exact product that needs to be installed might feel better.
There was a problem hiding this comment.
I will add a note, but generally ARM chips are M1 > series and x64 are Intel based Macs.
| @@ -0,0 +1,93 @@ | |||
| # Kendo UI for Angular Grid and Upload Component with Java Spring Boot: A Sample Project | |||
There was a problem hiding this comment.
how about shortening the title a bit to Kendo UI for Angular with Java Spring Boot Integration?
in the description, we can add details about the Grid and Upload.
| - **Java Development Kit (JDK 23)**: Essential for running Java applications. [Download JDK](https://www.oracle.com/java/technologies/downloads/). | ||
| - **Apache Maven**: A build automation tool for Java projects. Install using [Homebrew](https://brew.sh/) on macOS, or [download manually](https://maven.apache.org/install.html). | ||
|
|
||
| ### 2. Clone the Repository |
There was a problem hiding this comment.
the cloning of the repo could be moved to prerequisites.
| git clone https://github.com/telerik/kendo-angular/ | ||
| ``` | ||
|
|
||
| ### 3. Set Up the Java Spring Boot Project |
There was a problem hiding this comment.
we can add a H2 Setup and Run the Java Spring Boot App with a numeric list inside, listing all related information:
- navigate
- run the app
- the app is hosted on localhost
|
|
||
| ### 4. Set Up the Angular Project | ||
|
|
||
| - **Navigate to the Frontend Directory**: |
There was a problem hiding this comment.
we can add a H2 Setup and Run the Angular App with a numeric list
- navigate .. cd ...
- install project dep..
- run the app
- navigate to localhost...
| ## Functionality | ||
|
|
||
| The application demonstrates the following features: | ||
|
|
||
| - **Grid Component**: | ||
| - Displays a list of products. | ||
| - Supports client-side sorting, filtering, grouping, and paging using the [process helper](https://www.telerik.com/kendo-angular-ui/components/data-query/bulk-operations). | ||
| - Performs Create, Read, Update, and Delete (CRUD) operations on the server. | ||
|
|
||
| - **Upload Component**: | ||
| - Allows users to upload files to the server. | ||
|
|
||
| ## Project Structure | ||
|
|
||
| The project consists of two main parts: | ||
|
|
||
| - **Frontend**: Contains the Angular application, located in the `frontend` directory. | ||
| - **Backend**: Contains the Java Spring Boot application, located in the `backend` directory. | ||
|
|
There was a problem hiding this comment.
These are good to start the document with it.
Links to the components' overview could also be beneficial.
No description provided.