LNReader Plugins

Repository to host plugins and related issues, and requests for LNReader.

Contributing

1. Please use this template or template.min

2. Choose your language in ./plugins

• If your language doenst exist, please request us. We will add it soon.

3. Write your scripts

• See example: Hako

Test your script

We use expressjs to make an UI web for testing.

1. Installing

npm install

2. Running

nodemon index.js

• Then open http://localhost:3000

3. Testing

• Find you plugin

• Check if all functions of your plugin work properly

No need to reload webpage after changing your plugin script.

• One more thing: you can use cheerio_space to build functions without requesting to the site.

---

If you want to test plugin in app side, remember to config these things.

in .env

1. Create config.json file in root dir
2. Add your github infomation. Here is an example.

{
	"githubUsername": "LNReader",
	"githubRepository": "lnreader-sources",
	"githubBranch": "plugins"
}

3. Just commit and push it. And you will see your own json files in github folk: dist/username/

also in pluginManager.ts (app repo)

const  githubUsername  =  'LNReader';
const  githubRepository  =  'lnreader-sources';
const  githubBranch  =  'plugins';

• Note: You dont have to remove your own json files when creating a PR.

---

The developer of this application does not have any affiliation with the content providers available.