profile-summary-for-github Documentation

File: README.md Copy Chapter

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

A tool to visualize your GitHub presence.

File: Documentation/Building.md Copy Chapter

Building

How to setup and compile the project.

Docker Copy Chapter

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

Steps Copy Chapter

• Clone the repository

  shell Copy

  git clone https://github.com/tipsy/profile-summary-for-github.git

• Navigate to the root folder

  shell Copy

  cd profile-summary-for-github

• Install the dependencies

  shell Copy

  mvn install

• Compile the source code

  shell Copy

  java -jar target/profile-summary-for-github-jar-with-dependencies.jar

File: Documentation/Docker.md Copy Chapter

Docker

How to use this project with docker.

Building Copy Chapter

How to compile the source code.

• Clone the repository

  shell Copy

  git clone https://github.com/tipsy/profile-summary-for-github.git

• Navigate to the root folder

  shell Copy

  cd profile-summary-for-github

• Compile the source code

  shell Copy

  docker build -t profile-summary-for-github

Running Copy Chapter

How to start the compiled project.

Without Token Copy Section

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

With Token Copy Section

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 Copy Section

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

File: Documentation/Usage.md Copy Chapter

Usage

How to configure the project.

API Token Copy Chapter

The access token to GitHubs API.

Without Copy Section

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

With Copy Section

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

Provide the token in the following way:

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 Copy Chapter

Command line options you can set.

Unrestricted Copy Section

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

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

Free Threshold Copy Section

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:

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

Google Tag Manager Copy Section

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

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