nyagami
e602df44c8
* remove lang, descrription in plugin script * remove languages import * Update README.md * fix: missing lang * clean: remove description * feat(Add Sources) (#15) * add many sources * add showToast * feat(Add Source): (#16) * add source * remove descriptions * Early Novel & Fast Novel (#1) * some more plugin * plugin * try something new * yes * try yes * genres is plural * fastnovel full fix * testings * early check * earlynovel fixed * showToast check * earlynovel done * fastnovel fixe * again * showToasts again * fix for fastnovel * done * for pr * Update freenovelupdates.js * MTL Reader and MTL Novel (#2) * first * test * wops * mtlreaders * ok * for PR * Nitro Scans and Novel Hold (#3) * start feature * more feature * something * eslint * yes * maybe * wa * asdasd * amazing * change it up * for pr * WPmangastream and Novelfull (#4) (#17) * source generation * fix json parse error * update plguins * delete fetchApi, nobleMTL (.js) * delete showToast.js * Typescript Support (#18) * Initial TS Config * Initial TS Config * Fix most errors * Fix test webserver * Fix webserver isPlugin not working * Fix typos * Add check if plugins have all the fields * Move exports.protected to the bottom of the plugin * Change username, reponame and branchname * Fix no exports error * Fix type * Fix typo in tsc_fix * Remove const from exports to not re-define consts * Readd const becuause exports may not exist. * Fix plugins to work in-app * Fix NobleMTL * Remove fix_ts.ts * Change template.ts * delete cheerio_space * move api into ./testweb * remove js dir * remove js dir (again) * remove ./js (again) * init multisrc generator (test) * remove module.exports in libs * madara generator * update template * rename generator, TS for hako * fix icon url for madara * fix icon for madara (again) * update Readme, nodemon * export default for all libs * fix madara novelurl * update: pluginId, name, filename for madara * feat: check same id error * update: precommit, fix: require.default * Revert "update: precommit, fix: require.default" This reverts commit c642c5c72241f13eccfe417210c22272c4739ffa. * Port all plugins to ts (#19) - fix cheerio - remove export default - fix spelling * update template * add multisrc noveltl, update generator param, fix web search * fix undefined id for Snailulitka * add rulate multisrc, fix max length textarea * add readwn multisrc * delete: erolate and rulate are in multisrc * Change broken extension and show error on commit for those files (#20) * Change to .broken.ts and show error on commit for those files * remove novelStatus * fix: wrong id in github action * remove mangastream multisrc * update icon for readwn multisrc --------- Co-authored-by: K1ngfish3r <trulyihu@gmail.com> Co-authored-by: Marcin Majewski <skilletssgames@gmail.com>
88 lines
2.0 KiB
Markdown
88 lines
2.0 KiB
Markdown
|
|
|
|
# LNReader Plugins
|
|
|
|
<p>
|
|
|
|
<img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/lnreader/lnreader-sources/Source%20Request?color=success&label=source%20requests">
|
|
|
|
<img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/lnreader/lnreader-sources/Bug?color=red&label=bugs">
|
|
|
|
</p>
|
|
|
|
Repository to host plugins and related issues, and requests for [LNReader](https://github.com/LNReader/lnreader).
|
|
|
|
## Contributing
|
|
|
|
1. Please use this [template](./template.ts) or [template.min](./template.min.ts)
|
|
|
|
2. Choose your language in [./plugins](./plugins)
|
|
|
|
+ If your language doenst exist or you need some other packages, please request us. We will add it soon.
|
|
|
|
3. Write your scripts
|
|
|
|
+ See example: [Hako](./plugins/vietnamese/LNHako.ts)
|
|
|
|
Multisrc: [multisrc](./scripts/multisrc)
|
|
|
|
## Test your script
|
|
|
|
We use expressjs to make an UI web for testing.
|
|
|
|
1. Installing
|
|
|
|
```
|
|
npm install
|
|
```
|
|
|
|
2. Running
|
|
|
|
```
|
|
npm start
|
|
```
|
|
or
|
|
```
|
|
nodemon
|
|
```
|
|
|
|
+ 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.
|
|
|
|
----------
|
|
|
|
If you want to test plugin in app side, remember to config these things.
|
|
|
|
|
|
1. Create `config.json` file in root dir
|
|
2. Add your github infomation. Here is an example.
|
|
```json
|
|
{
|
|
"githubUsername": "LNReader",
|
|
"githubRepository": "lnreader-sources",
|
|
"githubBranch": "plugins"
|
|
}
|
|
```
|
|
3. Just commit and push it. And you will see your own json files in github fork: dist/`username`/
|
|
|
|
also in [pluginManager.ts](https://github.com/LNReader/lnreader/blob/plugins/src/plugins/pluginManager.ts) (app repo)
|
|
|
|
```ts
|
|
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.
|