https://github.com/aivruu/repo-viewer

Utility for view GitHub repositories' information/releases, and download releases' assets.
https://github.com/aivruu/repo-viewer

downloader functional-programming github github-api gradle http-requests https java json library viewer

Last synced: 3 months ago
JSON representation

Utility for view GitHub repositories' information/releases, and download releases' assets.

• Host: GitHub
• URL: https://github.com/aivruu/repo-viewer
• Owner: aivruu
• License: gpl-3.0
• Created: 2024-03-23T19:29:57.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-10-18T01:18:02.000Z (3 months ago)
• Last Synced: 2024-10-20T13:20:02.260Z (3 months ago)
• Topics: downloader, functional-programming, github, github-api, gradle, http-requests, https, java, json, library, viewer
• Language: Java
• Homepage: https://javadoc.jitpack.io/com/github/aivruu/repo-viewer/repo-viewer-api/latest/javadoc/
• Size: 297 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: docs/readme.md
  • License: license

Awesome Lists containing this project

README

        
# repo-viewer | [![Codacy Badge](https://app.codacy.com/project/badge/Grade/2af8dd31da77439ea518ee1df8d725be)](https://app.codacy.com/gh/aivruu/repo-viewer/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

[![](https://jitpack.io/v/aivruu/repo-viewer.svg)](https://jitpack.io/#aivruu/repo-viewer)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/aivruu/repo-viewer/build.yml)

![GitHub License](https://img.shields.io/github/license/aivruu/repo-viewer)

![GitHub commit activity](https://img.shields.io/github/commit-activity/t/aivruu/repo-viewer)

`repo-viewer` permits to get information about GitHub repositories, and any release published for these repositories, besides of allowing download these releases' adjunted assets, providing several functionalities with a decent code-quality and an understandable and very docummented structure.

> [!NOTE]\

> I started this project with the only propuse of testing HTTP utilities with Java. I taken as base [OcZi/release-watcher](https://github.com/OcZi/release-watcher) for the main idea of this project.

## Features

* View specified repository's information.

* View each repository's releases' information.

* Permits comparing between releases' defined tag-names.

* Easy to usage.

* Download assets from each repository release.

## Guides

* [Download assets from any repository releases.](https://github.com/aivruu/repo-viewer/blob/main/docs/download-assets-guide.md)

* [Make a request to an specified repository.](https://github.com/aivruu/repo-viewer/blob/main/docs/make-request-guide.md)

* [Compare a release's tag-name with another.](https://github.com/aivruu/repo-viewer/blob/main/docs/version-comparing-guide.md)

## Download

```kotlin

repositories {

  maven("https://jitpack.io/")

}

dependencies {

  // You can visualize the latest version on the document header.

  implementation("com.github.aivruu:repo-viewer:VERSION")

}

```

## Building

This project require Gradle for building and management, and Java 21 as minimum.

```

git clone https://github.com/aivruu/repo-viewer.git

cd repo-viewer

./gradlew shadowJar

```