# Development Environment Setup
-----------

## Eclipse based setup

### Procedure
1. Make sure you have JDK 11 installed
1. Make sure you have [Git](https://git-scm.com/) version 2.11.1 or higher installed
1. Install [Eclipse Oxygen or higher](http://www.eclipse.org/) for Java development
1. Create a new directory as Eclipse workspace. Let's assume it to be _/home/robin/workspace_
1. Clone OneDev source code into a sub directory under Eclipse workspace:

    ```
    cd /home/robin/workspace
    git clone https://code.onedev.io/onedev/server onedev-server
    ```
1. Run Eclipse and open workspace _/home/robin/workspace_
2. Specify JDK instead of JRE as default. Otherwise, Eclipse will not be able to access Java sources to get help

    ![use-jdk-as-default.png](../images/development-environment-setup/use-jdk-as-default.png)
    
2. Edit Maven preferences to check the option _Hide folders of physically nested modules_:

    ![maven-preference.png](../images/development-environment-setup/maven-preference.png)
    
1. Import existing maven projects as below:

    ![import-maven-projects.png](../images/development-environment-setup/import-maven-projects.png)
    -------------
    ![Import Workspace Projects](../images/development-environment-setup/import-workspace-projects.png)
    
1. Wait patiently for Eclipse to download necessary dependencies and build. In case there are compilation errors, update the projects as below:

    ![update-project.png](../images/development-environment-setup/update-project.png)
    
1. After build succeeds, you may run OneDev as below:

    ![run-as-java-application.png](../images/development-environment-setup/run-as-java-application.png)
    ----------
    ![select-bootstrap-class.png](../images/development-environment-setup/select-bootstrap-class.png)
    
### Trouble Shooting

1. In case there are compilation errors even if you've updated the project as described in step 11 above, run below from command line to make sure it succeeds:
  ```bash
  cd /home/robin/workspace/onedev-server
  mvn clean package
  ```
  If it still does not work, most probably your network has some issues downloading dependencies. Otherwise go back to Eclipse, **refresh** and **update** all projects, then errors should go away.
  
1. In case OneDev reports _Unable to find product directory_ upon running. Please check launched configuration and make sure project is specified as _server-product_ as below:
    
    ![Run Configuration Project](../images/development-environment-setup/run-configuration-project.png)
    
    If you still get the error, check if directory _/home/robin/workspace/onedev-server/server-product/target/sandbox_ exists. This directory should be created automatically as long as compilation is successful in Eclipse


## CLI based setup

If you don't want to use Eclipse for any reason it is also possible to compile/run OneDev via CLI:

1. Make sure you have JDK 11 installed
1. Make sure you have [Maven](https://maven.apache.org/) version 3.6.3 or higher installed
1. Make sure you have [Git](https://git-scm.com/) version 2.11.1 or higher installed

1. Clone OneDev source code
    ```
    git clone https://code.onedev.io/onedev/server onedev-server
    ```

1. Run maven install from `./onedev-server`
   ```
   cd onedev-server
   mvn install
   ```

1. Run the Boostrap class from `./server-product`
   ```
   cd server-product
   mvn exec:java -Dexec.mainClass="io.onedev.commons.bootstrap.Bootstrap"
   ```