https://github.com/inabajunmr/treview

Viewer for GitHub Trending. You never see same project on GitHub trending.
https://github.com/inabajunmr/treview

github trending

Last synced: 5 days ago
JSON representation

Viewer for GitHub Trending. You never see same project on GitHub trending.

• Host: GitHub
• URL: https://github.com/inabajunmr/treview
• Owner: inabajunmr
• License: mit
• Created: 2018-10-01T16:00:23.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-04-23T04:35:24.000Z (almost 4 years ago)
• Last Synced: 2024-09-24T09:22:51.702Z (over 1 year ago)
• Topics: github, trending
• Language: Go
• Homepage:
• Size: 4.91 MB
• Stars: 17
• Watchers: 2
• Forks: 3
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# treview

[![codecov](https://codecov.io/gh/inabajunmr/treview/branch/master/graph/badge.svg)](https://codecov.io/gh/inabajunmr/treview)

![CircleCI](https://circleci.com/gh/inabajunmr/treview/tree/master.svg?style=svg)

[![Total alerts](https://img.shields.io/lgtm/alerts/g/inabajunmr/treview.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/inabajunmr/treview/alerts/)

Viewer for GitHub Trending.

# Feature

* shows only today's newcomer repository.(You never see same project everyday!)

* define default langage that you want to see.

* [GUI for macos](https://github.com/inabajunmr/treview/releases)

# GUI

![treview](https://user-images.githubusercontent.com/10000393/60991913-69f32b80-a386-11e9-8ae7-428e3e655777.png)

## Install

Download from [GUI for macos](https://github.com/inabajunmr/treview/releases).

# CLI

![treview](https://user-images.githubusercontent.com/10000393/46803178-6ea89600-cd9a-11e8-8ca6-ad52c58ed942.gif)

## Install

```

$ go get github.com/inabajunmr/treview

```

## Usage

```

$ treview -h

Usage:

  treview is cli viewer for GitHub Trending. [flags]

  treview [command]

Available Commands:

  config      Setting for default langage configration.

  help        Help about any command

Flags:

  -f, --filter string   all or new (default "new")

  -h, --help            help for treview

  -l, --lang string     filter by lang

  -s, --span string     trending span (default "Today")

Use "treview [command] --help" for more information about a command.

```

### Config

If you have file `~/.treview/.config`, you can set default lang by treview.

You can set config by `treview config` command too.

![treview](https://user-images.githubusercontent.com/10000393/46802798-656af980-cd99-11e8-88fb-a91a72fbfcfd.gif)

#### Example

If you have following config, treview show only Golang and JavaScript repositories by `treview` command (without lang flag).

```yaml

lang:  [go, javascript]

```

If you want to find all langage, you set `all` as lang flag.

# Appendix (Using as GitHub Trending API for Golang)

[![GoDoc](https://godoc.org/github.com/inabajunmr/treview/github?status.svg)](https://godoc.org/github.com/inabajunmr/treview/github)

## Sample

```go

package main

import (

	"fmt"

	"github.com/inabajunmr/treview/github/trending"

)

func main() {

	span := trending.GetSpanByString("today")

	repos, err := trending.FindTrending(l, span)

	if err != nil {

		println(err)

		os.Exit(1)

	}

	for _, repo := range repos {

		fmt.Println("------------------------")

		repo.Print()

	}

}

```