Skip to content

heycatch/goshikimori

Repository files navigation

EN | RU

About

A small library for interacting with shikimori, written in golang.

  • Work with API occurs only through OAuth2.
  • No dependencies on other libraries.
  • The GNU make utility is used for tests and builds.

Install

go get github.com/heycatch/goshikimori

Examples

GODOC / GOPKG documentation

Godoc support is also available.

Or you can use the page from the official Go pkg website.
P.S. documentation is late in updating.

# Method #1: Use docker.
git clone git@github.com:heycatch/goshikimori.git && cd goshikimori
make docker-build
make docker-start

# Open in browser.
http://localhost:1337/pkg/github.com/heycatch/goshikimori
# Method #2(Linux): Install godoc.
go install -v golang.org/x/tools/cmd/godoc@latest
# Add 'export' to the file /home/$USER/.profile and reboot.
export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin
# Check that the application is working properly.
godoc --help

# After installation or if 'godoc' is already installed.
git clone git@github.com:heycatch/goshikimori.git && cd goshikimori
make doc

# Open in browser.
http://localhost:1337/pkg/github.com/heycatch/goshikimori

Shikimori documentation

Feedback

# Current tasks and problems in the code can be viewed in the terminal using the command.
git grep TODO
git grep FIXME

Languages