# Building

*How to setup and compile the project.*

<br>

## Docker

You can also use **[Docker]** to <br>
compile & run the project.

<br>
<br>

## Steps

-   Clone the repository

    ```shell
    git clone https://github.com/tipsy/profile-summary-for-github.git
    ```
    
-   Navigate to the root folder

    ```shell
    cd profile-summary-for-github
    ```
    
-   Install the dependencies

    ```shell
    mvn install
    ```
    
-   Compile the source code

    ```shell
    java -jar target/profile-summary-for-github-jar-with-dependencies.jar
    ```
    
<br>


<!----------------------------------------------------------------------------->

[Docker]: Docker.md