Support VS Code, IntelliJ (eclipse-ee4j#201)

santapan345 · Mar 11, 2023 · 9237cce · 9237cce
1 parent 8ed6486
commit 9237cce
Show file tree

Hide file tree

Showing 16 changed files with 108 additions and 0 deletions.
diff --git a/vscode/image/cargo.png b/vscode/image/cargo.png
diff --git a/vscode/image/final.png b/vscode/image/final.png
diff --git a/vscode/image/javaee8.png b/vscode/image/javaee8.png
diff --git a/vscode/image/maven.png b/vscode/image/maven.png
diff --git a/vscode/image/maven1.png b/vscode/image/maven1.png
diff --git a/vscode/image/maveni.png b/vscode/image/maveni.png
diff --git a/vscode/image/more.png b/vscode/image/more.png
diff --git a/vscode/image/payara1.png b/vscode/image/payara1.png
diff --git a/vscode/image/payara2.png b/vscode/image/payara2.png
diff --git a/vscode/image/payara3.jpg b/vscode/image/payara3.jpg
diff --git a/vscode/image/payara5.jpg b/vscode/image/payara5.jpg
diff --git a/vscode/image/payara6.jpg b/vscode/image/payara6.jpg
diff --git a/vscode/image/payara7.png b/vscode/image/payara7.png
diff --git a/vscode/image/payara_server.png b/vscode/image/payara_server.png
diff --git a/vscode/image/run.png b/vscode/image/run.png
diff --git a/vscode/vscode.md b/vscode/vscode.md
@@ -0,0 +1,108 @@
+This section outlines how to set up the application in the VS CODE IDE.
+
+## Prerequisites
+
+* Java SE 8, Java SE 11 or Java SE 17 is required.
+* Payara Server 5 is required. You can download Payara Server 5 from [here](https://www.payara.fish/downloads/).
+* The VS CODE IDE is required. You can download the VS CODE from [here](https://code.visualstudio.com/download).
+
+## Download
+
+[Download](https://github.com/eclipse-ee4j/cargotracker/archive/master.zip) the source code zip file and expand it somewhere in your file system. Note that this is a Maven project.
+
+## VSCODE IDE Setup
+
+Before going through this tutorial, you must install the following extensions from the Visual Studio Code marketplace:
+
+* [Java Extension Pack, by Microsoft](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack)
+* [Payara Tools, by Payara](https://marketplace.visualstudio.com/items?itemName=Payara.payara-vscode)
+
+You can install extensions from Extensions view (Ctrl + Shift + X) in the activity bar of VS Code:
+
+![Payara](image/payara_server.png)
+
+Maven is the most widely used project build and dependency management tool in the Java ecosystem. 
+Generate a Maven Web Application through the Maven archetypes and deploy the application to the Payara Server. 
+
+Let’s start:
+
+ * Open the command pallet using Ctrl + Shift + P, type Maven and select the Create Maven Project option:
+
+  ![Maven](image/maven.png)
+
+ * Or in the explorer sidebar expand Maven Projects, Select the + sign to create a Maven Project:
+
+  ![Maven](image/maven1.png)
+
+ * Select More… option to find archetype available in remote catalog:
+
+  ![More](image/more.png)
+
+ * Search for the javaee8-essentials-archetype or you may select any other archetype:
+
+  ![Javaee8](image/javaee8.png)
+
+ * Select the destination folder, where the project folder will be generated and answer the prompts (groupId, artifactId, version etc) in the focused TERMINAL window to setup the maven project.
+
+ * Open the Maven project folder in VS Code via File menu -> Open Folder… and select the CARGOTRACKER-MASTER project folder:
+
+ ![Cargo](image/cargo.png)
+
+ ## Adding Payara Server
+
+ * Open the command pallet using Ctrl + Shift + P, type Payara and select the Add Payara Server option:
+
+ ![payara1](image/payara1.png)
+
+ * Or In the explorer sidebar (or Payara activity bar), expand Payara Servers, Select the + sign to add Payara Server:
+
+ ![payara2](image/payara2.png)
+
+ * Select the location of your 'payara5' directory within the Payara Server installation:
+
+ ![payara3](image/payara3.png)
+
+ * Now name the server whatever you want. For this example I've named it 'Payara-Server-5.201'. Press Enter:
+
+ ![payara5](image/payara5.png)
+
+ * Finally, select a domain from the list or press the + sign to create the new domain:
+
+ ![payara6](image/payara6.png)
+
+ * Then, select the maven side-bar & righ-click to install:
+
+ ![Maveni](image/maveni.png)
+
+ * After Build success. To start the Payara Server right click on the server in Payara Server explorer and select Start:
+
+ ![payara7](image/payara7.png)
+
+ * After starting the server, you may see the server log in the OUTPUT window:
+
+ ## Running the Payara Server Application
+
+ * Now go to your project, and find the cargo-tracker.war file. Ther right click on it and select the Run on Payara Server option. The project will start and application will be deployed to Payara Server (Payara Server instance will be started if not running already):
+
+ ![Run](image/run.png)
+
+ * Now you should see a page (http://localhost:8080/cargo-tracker), eventually opened in your default browser.
+
+ ![Final](image/final.png)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+