Skip to content

BytewaveMLP/node-derpi

Repository files navigation

node-derpi

GitHub version npm version Discord chat

A Derpibooru API wrapper for Node.js

node-derpi is my first attempt at an API wrapper in Node, specifically for the Derpibooru image board. It aims to be a rich API wrapper around Derpibooru's JSON API, supporting rich deserialization of supported types (dates, other Derpi data points, etc.). It is also fully strongly-typed, being written in Typescript.

Table of Contents

Install

Prerequisites

  • Node.js
  • Your Node package manager of choice (I recommend yarn)

Installation

Using yarn:

yarn add node-derpi

Using npm:

npm install node-derpi

That's it! Your package manager should handle any dependencies for you.

Usage

See the documentation.

Maintainers

Contribute

Issues, suggestions, or concerns? Submit a GitHub issue!

Want to add a feature? We accept PRs!

License

Copyright (c) Eliot Partridge, 2018. Licensed under the MIT License.