Skip to content

LNReader/lnreader-plugins

Repository files navigation

LNReader Plugins

Total number of available plugins Open plugin requests Open bug reports

Community-driven plugin repository for LNReader. This repository hosts plugins and manages related issues and requests.

Quick Start

Prerequisites: Node.js >= 20

npm install
npm run dev:start

Documentation

Testing Methods

Web Interface

npm run dev:start

Open localhost:3000 to test plugins interactively. See the testing guide for details.

Mobile App

From GitHub (Automated):

Push your changes to the master branch. The GitHub Action automatically builds and publishes plugins to the plugins branch.

Add your repository URL to the app:

https://raw.githubusercontent.com/<username>/<repo>/plugins/<tag>/.dist/plugins.min.json

From Localhost:

npm run serve:dev

Add http://10.0.2.2/.dist/plugins.min.json (Android emulator) to the app. Requires .env configuration (see .env.template).

Disclaimer

The developers are not affiliated with any content providers. If you are a non-aggregator website owner, you may request plugin removal via Discord or by creating an issue. Removed sites are added to the blacklist.

About

Repository to host source related issues, and requests for LNReader

Topics

Resources

License

Stars

Watchers

Forks