## File: README.md

# Profile Summary   [![Badge License]][License]

*A tool to visualize your **GitHub** presence.*





---

[![Button Demo]][Demo]   
[![Button Building]][Building]   
[![Button Usage]][Usage] 

---










[Demo]: https://profile-summary-for-github.com/

[Building]: Documentation/Building.md
[License]: LICENSE
[Usage]: Documentation/Usage.md




[Badge License]: https://img.shields.io/badge/License-Apache_2.0-D22128?style=for-the-badge




[Button Building]: https://img.shields.io/badge/Building-7952B3?style=for-the-badge&logoColor=white&logo=AzureArtifacts
[Button Usage]: https://img.shields.io/badge/Usage-239120?style=for-the-badge&logoColor=white&logo=GitBook
[Button Demo]: https://img.shields.io/badge/Demo-0091BD?style=for-the-badge&logoColor=white&logo=AppleArcade

---

## File: Documentation/Building.md

# Building

*How to setup and compile the project.*



## Docker

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




## 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
    ```
    





[Docker]: Docker.md

---

## File: Documentation/Docker.md

# Docker

*How to use this project with docker.*



## Building

*How to compile the source code.*



-   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
    ```
    
-   Compile the source code

    ```shell
    docker build -t profile-summary-for-github
    ```
    



## Running

*How to start the compiled project.*



### Without Token

```shell
docker run                              \
    -it                                 \
    --rm                                \
    --name profile-summary-for-github   \
    -p 7070:7070 profile-summary-for-github
```



### With Token

```shell
docker run                              \
    -it                                 \
    --rm                                \
    --name profile-summary-for-github   \
    -p 7070:7070                        \
    -e "API_TOKENS=<My Token A>,<My Token B>" profile-summary-for-github
```



### Interface

You can access it at http://localhost:7070

---

## File: Documentation/Usage.md

# Usage

*How to configure the project.*



## API Token

*The access token to GitHubs API.*



### Without

If no api token is set, you only get `~50 requests / hour`.



### With

To run the app with an api-token, first **[Generate A Token]**.

Provide the token in the following way:

```shell
java                        \
    -Dapi-tokens=your-token \
    -jar target/profile-summary-for-github-jar-with-dependencies.jar
```

*You can use a comma-separated list* 
*of tokens to increase your rate-limit.*




## Parameters

*Command line options you can set.*



### Unrestricted

You can allow the building of any GitHub 
profile by passing `-Dunrestricted=true` :

```shell
java                    \
    -Dunrestricted=true \
    -jar target/profile-summary-for-github-jar-with-dependencies.jar
```



### Free Threshold

You can set when the app should require 
the user to star the GitHub repository.

*Pass the number of remaining requests at which the* 
*cutoff should kick in, as seen in the following example:*

```shell
java                            \
    -Dfree-requests-cutoff=1000 \
    -jar target/profile-summary-for-github-jar-with-dependencies.jar
```



### Google Tag Manager

You can enable this feature by passing the `gtm-id`.

```shell
java                    \
    -Dgtm-id=GTM-XXXXXX \
    -jar target/profile-summary-for-github-jar-with-dependencies.jar
```






[Generate A Token]: https://github.com/settings/tokens