Giter Club home page Giter Club logo

jellyfin-apiclient-javascript's Introduction

Jellyfin API Client for JavaScript

Part of the Jellyfin Project


Logo Banner

MIT License Donate Feature Requests Discuss on our Forum Chat on Matrix Join our Subreddit

This library is meant to help clients written in JavaScript or TypeScript interact with Jellyfin's REST API.

Compatibility

This library depends on the Fetch and Promise APIs. These will be expected to be polyfilled if used in a browser that doesn't support them.

Build Process

Dependencies

  • Yarn

Getting Started

  1. Clone or download this repository

    git clone https://github.com/jellyfin/jellyfin-apiclient-javascript.git
    cd jellyfin-apiclient-javascript
  2. Install build dependencies in the project directory

    yarn install
  3. Build the library for production

    yarn build
  4. Build the library for development

    yarn dev

Building Documentation

This library is documented using JSDoc style comments. Documentation can be generated in HTML format by running yarn docs and viewing the files in any modern browser. The resulting documentation will be saved in the docs directory.

jellyfin-apiclient-javascript's People

Contributors

anthonylavado avatar barongreenback avatar camc314 avatar confusedpolarbear avatar crobibero avatar cvium avatar dependabot[bot] avatar dkanada avatar dmitrylyzo avatar drpandemic avatar ebr11 avatar ferferga avatar h1dden-da3m0n avatar hazcod avatar heyhippari avatar joshuaboniface avatar justaman avatar lukepulverenti avatar masterkoppa avatar nik0kin avatar nyanmisaka avatar oancaandrei avatar oddstr13 avatar redspoutnik avatar thornbill avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.