nyagami
6bc3900d30
* remove .env file * remove dotenv, move json dir * fix: create dir if not exists * test actions * fix: specific branch * test double commit * fix: only add dist dir * cleanup * test push without updating json * test actions without plugins diff * plugins: update json files for new plugins (#7) * test without config.json * plugins: update json files for new plugins (#8) * fix: ordering in Win is not the same as Linux * plugins: update json files for new plugins (#10) * test no update * test: create PR if there're changes * fix: wrong path * test: if there're changes * fix: wrong operator * fix: assign boolean to github output * plugins: update json files for new plugins (#13) * clean up and update README * clean up * last cleant up xD
2.0 KiB
2.0 KiB
LNReader Plugins
Repository to host plugins and related issues, and requests for LNReader.
Contributing
-
Please use this template or template.min
-
Choose your language in ./plugins
- If your language doenst exist, please request us. We will add it soon.
- Write your scripts
- See example: Hako
Test your script
We use expressjs to make an UI web for testing.
- Installing
npm install
- Running
nodemon index.js
- Then open http://localhost:3000
- 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
- Create
config.jsonfile in root dir - Add your github infomation. Here is an example.
{
"githubUsername": "LNReader",
"githubRepository": "lnreader-sources",
"githubBranch": "plugins"
}
- 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.