dev-support/contributor/local/README.md

### Requirements

1. JDK 1.8 + version, Docker 3.8 version and above

2. Executing `mvn clean install -DskipTests` manually and make sure that compiler is ok.

3. Install Docker Desktop on local machine and configure the Docker resource, as follows is the lowest requirement：

   ![image-20211102111253713](images/docker_resources.png)


### Usage

1) Executing `./dev-support/local/local.sh init` to initialize env.

- Current step will download the spark to local, and if download failed will notify user to download by the scripts.

  > Note: If the spark already exists, the spark will delete and re-download it.

- Current step will load the `run configuration` automatically to IDEA.

- Current step will install frontend env.

*Executing Result*

![Executing Result](images/executing_result.png)

* Run Configuration for IDEA Debug*

![image-20211102105411171](images/idea_configuration.png)


3) Executing `./dev-support/local/local.sh up` to download images and start the container。

*Container started successfully*

![image-20211102110553460](images/docker_container.png)


4) After start IDEA Debug and access to `http://localhost:8080/` to check Kylin started successfully.

* Run into Kylin web and enjoy.

![Kylin WebSite](images/kylin_ui.png)

* Access to `http://localhost:4041/` to check sparder started successfully.
  
![Sparder](images/sparder.png)


### Other Usage

1) `./dev-support/local/local.sh stop`        : Stop the running containers

2) `./dev-support/local/local.sh start`       : Start all stopped containers

3) `./dev-support/local/local.sh ps`          : List all containers

4) `./dev-support/local/local.sh down`        : Stop all containers and delete them

5) `./dev-support/local/local.sh interactive` : Enter in specific container

### FAQ

1) After executing `local.sh init` and runConfiguration has nothing change. Then replace `type="SpringBootApplicationConfigurationType" factoryName="Spring Boot"` to `type="Application" factoryName="Application"` in `.idea/runconfigurations/BootstrapServer_local.xml`.

![](images/run_configuration_replace.png)