EN | RU

О проекте

Небольшая библиотека для взаимодействия с шикимори, написанная на языке golang.

• Работа с API происходит только через OAuth2.
  И начать нужно с ознакомления документации первые шаги.
• Никаких зависимостей от других библиотек.
• Для тестов и сборки используется утилита GNU make.

Установка

go get github.com/heycatch/goshikimori

Готовые примеры

• Нажать сюда

Документация GODOC / GOPKG

Также доступна поддержка godoc.

Или вы можете использовать страницу с официального сайта Go pkg.
P.S. документация обновляется с опозданием.

# Способ #1: Используя докер.
git clone [email protected]:heycatch/goshikimori.git && cd goshikimori
make docker-build
make docker-start

# Открыть в браузере.
http://localhost:1337/pkg/github.com/heycatch/goshikimori

# Способ #2(Linux): Установка godoc.
go install -v golang.org/x/tools/cmd/godoc@latest
# Добавить 'экспорт' в файл /home/$USER/.profile и перезагружаемся.
export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin
# Проверяем работоспособность.
godoc --help

# После установки или если 'godoc' уже установлен.
git clone [email protected]:heycatch/goshikimori.git && cd goshikimori
make doc

# Открыть в браузере.
http://localhost:1337/pkg/github.com/heycatch/goshikimori

Документация шикимори

• GraphQL
• API v1
• API v2

Обратная связь

• Написать в личные сообщения на сайте.
• Открыть проблему.

# Текущие задачи и проблемы в коде можно посмотреть в терминале с помощью команды.
git grep -c -e "TODO" -e "FIXME" -e "NOTES" -- . -- graphql/ -- concat/ -- api/ && \
git grep -n -e "TODO" -e "FIXME" -e "NOTES" -- . -- graphql/ -- concat/ -- api/