https://github.com/Jay9596/goRant

An unofficial Go API wrapper https://www.devrant.io
https://github.com/Jay9596/goRant

api-wrapper devrant go golang unofficial

Last synced: 3 months ago
JSON representation

An unofficial Go API wrapper https://www.devrant.io

• Host: GitHub
• URL: https://github.com/Jay9596/goRant
• Owner: Jay9596
• License: mit
• Created: 2017-06-16T14:57:33.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-08-26T16:46:07.000Z (about 7 years ago)
• Last Synced: 2024-06-23T11:40:49.019Z (5 months ago)
• Topics: api-wrapper, devrant, go, golang, unofficial
• Language: Go
• Homepage:
• Size: 4.88 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-devrant - goRant - Another Go wrapper for the devRant API (Uncategorized / Uncategorized)

README

        
# goRant

An unofficial Go client for public devRant API

https://www.devrant.io/  

[![Go Report Card](https://goreportcard.com/badge/github.com/jay9596/goRant)](https://goreportcard.com/report/github.com/jay9596/goRant)

## Table of Content

1. [Installation](#Installation)

2. [Documentation](#Documentation)

3. [Getting Started](#Getting-Started)

4. [Todo](#Todo)

## Installation:

 ``` go get github.com/jay9596/goRant ```

 

## Documentation

  ``` go doc github.com/jay9596/goRant ```  

  Or visit:

  [GoDoc](https://godoc.org/github.com/Jay9596/goRant)

## Getting Started

* ### goRant Functions

    #### Assign a New client  

      devRant := goRant.New()

     #### Rants : Fetch rants

     ``` rants,err := devRant.Rants() ```

     #### Rant : Fetch a single rant

     ``` rant,comments,err := devRant.GetRant(rantID) ```

     #### Profile : Fetch a user profile

     ``` user,err := devRant.Profile("byte") ```

     #### Search : Search on devrant

     ``` rants,err := devRant.Search("vscode") ```

     #### Surprise : Fetch a random rant

     ``` rant,comments,err := devRant.Surprise() ```

     #### WeeklyRant : Fetch weekly rants

     ``` rants,err := devRant.WeeklyRant() ```

     #### Collabs : Fetch collabs 

     ``` rants,err := devRant.Collabs() ```

     #### Stories : Fetch stories

     ``` rants,err := devRant.Stories() ```

* ### goRant Types

     All _rant_ specified above represent a **Rant** struct  

     The _rants_ represent an array of Rant  **[ ]Rant**  

     The _user_ represent **User** struct  

     The _comments_ represent an array of Comment **[ ]Comment**  

 

 ## Todo

 - [x] Add supporter ++ support   

 - [ ] Add Tests