zhoujinsong commented on code in PR #3615: URL: https://github.com/apache/amoro/pull/3615#discussion_r2151225549
########## CONTRIBUTING.md: ########## @@ -83,7 +83,94 @@ for reference. ## Building the Project Locally -[Build Guide](https://github.com/apache/amoro?tab=readme-ov-file#building) can be found in GitHub readme. +The following guide describes how to import the Amoro project into IntelliJ IDEA and deploy it. + +### Requirements ++ Java Version: Java 8 or Java 11 is required. + +#### Required Plugins +1. Go to `Settings` → `Plugins` in IntelliJ IDEA. +2. Select the “Marketplace” tab. +3. Search for and install the following plugins: + - Scala +4. Restart IntelliJ IDEA if prompted. + +### Importing Amoro into IntelliJ IDEA +This guide is based on IntelliJ IDEA 2024. Some details might differ in other versions. + +1. Clone the Repository and Create the Configuration File: + +```shell +$ git clone https://github.com/apache/amoro.git +$ cd amoro +$ base_dir=$(pwd) +$ mkdir -p conf +$ cp dist/src/main/amoro-bin/conf/config.yaml conf/config.yaml +``` + +2. Import the Project: + 1. Open IntelliJ IDEA and select `File`->`Open`. + 2. Choose the root folder of the cloned Amoro repository. +3. Configure Java Version: + 1. Open the `Maven` tab on the right side of the IDE. + 2. Expand `Profiles` and ensure the selected Java version matches your IDE's Java version. + 3. To check or change the project SDK, go to `File`->`Project Structure...`->`Project`->`SDK`. +4. Modify the Configuration File: + + The AMS server requires configuration for database connections. The configuration command in the macOS system is presented as follows. In the Linux system, `-i ''` should be replaced with `-i`. + +```shell +$ sed -i '' "s|/tmp/amoro/derby|${base_dir}/conf/derby|g" conf/config.yaml Review Comment: How about moving this command into the `1. Clone the Repository and create the configuration file` part? ########## CONTRIBUTING.md: ########## @@ -83,7 +83,94 @@ for reference. ## Building the Project Locally -[Build Guide](https://github.com/apache/amoro?tab=readme-ov-file#building) can be found in GitHub readme. Review Comment: You should now remove the guide here. Maybe add a new chapter `## Import the Amoro project into IntelliJ IDEA` here. ########## CONTRIBUTING.md: ########## @@ -83,7 +83,94 @@ for reference. ## Building the Project Locally -[Build Guide](https://github.com/apache/amoro?tab=readme-ov-file#building) can be found in GitHub readme. +The following guide describes how to import the Amoro project into IntelliJ IDEA and deploy it. + +### Requirements ++ Java Version: Java 8 or Java 11 is required. + +#### Required Plugins +1. Go to `Settings` → `Plugins` in IntelliJ IDEA. +2. Select the “Marketplace” tab. +3. Search for and install the following plugins: + - Scala +4. Restart IntelliJ IDEA if prompted. + +### Importing Amoro into IntelliJ IDEA +This guide is based on IntelliJ IDEA 2024. Some details might differ in other versions. + +1. Clone the Repository and Create the Configuration File: Review Comment: ```suggestion 1. Clone the repository and create the test configuration file: ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
