From c03ca88fb432f9f48009d0d6773d8dcf95401329 Mon Sep 17 00:00:00 2001 From: Yanmario Menev <49076727+yanmariomenev@users.noreply.github.com> Date: Fri, 4 Oct 2024 08:32:25 +0300 Subject: [PATCH] update README --- .../kendoangular-java-integration/readme.md | 52 +++++++++---------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/examples-standalone/kendoangular-java-integration/readme.md b/examples-standalone/kendoangular-java-integration/readme.md index 0e316920..844c9ab7 100644 --- a/examples-standalone/kendoangular-java-integration/readme.md +++ b/examples-standalone/kendoangular-java-integration/readme.md @@ -1,68 +1,75 @@ -# Kendo UI for Angular Grid and Upload Component with Java Spring Boot: A Sample Project +# Kendo UI for Angular with Java Spring Boot Integration This sample project demonstrates how to utilize Kendo UI for Angular's [Grid](https://www.telerik.com/kendo-angular-ui/components/grid/) and [Upload](https://www.telerik.com/kendo-angular-ui/components/uploads/upload/) components with a Java Spring Boot Maven backend. For more detailed information, refer to the [Java integration article](https://www.telerik.com/kendo-angular-ui/components/installation/java-spring). -## Getting Started +## Project Structure + +The project consists of two main parts: -Follow these steps to set up and run the project locally: +- **Frontend**: Contains the Angular application, located in the `frontend` directory. +- **Backend**: Contains the Java Spring Boot application, located in the `backend` directory. -### 1. Install Required Tools +## Prerequisites 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/). -- **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). + - Note: For macOS, ensure you download the correct installer for your architecture: + - **arm64**: For Apple Silicon (M1, M2, etc.) Macs. + - **x64**: For Intel-based Macs. -### 2. Clone the Repository +- **Apache Maven**: A build automation tool for Java projects. Install using [Homebrew](https://formulae.brew.sh/formula/maven) on macOS, or [download manually](https://maven.apache.org/install.html). -- **Command**: Clone the repository to your local machine to get the project files. +- **Clone the Repository**: Clone the repository to your local machine to get the project files. ```bash git clone https://github.com/telerik/kendo-angular/ ``` -### 3. Set Up the Java Spring Boot Project +## Setup and Run the Java Spring Boot App + +## Setup and Run the Java Spring Boot App -- **Navigate to the Backend Directory**: +1. **Navigate to the Backend Directory**: ```bash cd kendo-angular/examples-standalone/kendoangular-java-integration/backend ``` -- **Run the Java Spring Boot Application**: +2. **Run the Java Spring Boot Application**: ```bash mvn spring-boot:run ``` -### 4. Set Up the Angular Project +3. **Access the Java Spring Boot Application**: + - Open your browser and navigate to [http://localhost:8080](http://localhost:8080). -- **Navigate to the Frontend Directory**: +## Setup and Run the Angular Application + +1. **Navigate to the Frontend Directory**: ```bash cd kendo-angular/examples-standalone/kendoangular-java-integration/ClientApp ``` -- **Install Project Dependencies**: +2. **Install Project Dependencies**: ```bash npm install ``` -- **Run the Angular Application**: +3. **Run the Angular Application**: ```bash ng serve ``` -### 5. Access the Application - -- **Open Your Browser**: - - Navigate to `http://localhost:4200` to view the Angular application. - - The Java Spring Boot application runs on `http://localhost:8080`. +4. **Open Your Browser**: + - Navigate to [http://localhost:4200](http://localhost:4200) to view the Angular application. ## Functionality @@ -76,13 +83,6 @@ The application demonstrates the following features: - **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. - ## See Also - [Kendo UI for Angular integration with ASP.NET Core](https://www.telerik.com/kendo-angular-ui/components/installation/dotnet-core)