extension/README.md

51 lines
1.3 KiB
Markdown
Raw Normal View History

2019-10-13 21:52:56 +00:00
#### A WebExtensions add-on for browsers that talks with HappyPanda X from browsers
2019-10-13 16:53:26 +00:00
2019-10-20 21:14:48 +00:00
#### [HappyPanda X](https://github.com/happypandax/happypandax/) - [Support on Patreon](https://www.patreon.com/twiddly)
2019-10-13 16:53:26 +00:00
2019-10-13 21:52:56 +00:00
## Features
2019-10-13 16:53:26 +00:00
2019-10-13 21:52:56 +00:00
With this add-on, you can:
2019-10-13 16:53:26 +00:00
2019-10-13 21:52:56 +00:00
- Send manga & doujinshi to HPX for download from inside your browser
- Detect whether a manga or doujinshi is already inside your HPX database
2019-10-13 16:53:26 +00:00
2019-10-13 21:52:56 +00:00
#### Supported sites
2019-10-13 16:53:26 +00:00
2019-10-13 21:52:56 +00:00
- e-hentai.org
- exhentai.org
- panda.chaika.moe
2019-10-13 21:52:56 +00:00
- nhentai.net
2019-10-13 16:53:26 +00:00
2019-10-20 21:14:48 +00:00
## Installing
### Firefox
- Go to [releases](https://github.com/happypandax/extension/releases) and download the latest .xpi file
### Other
> I don't use Chrome so someone else has to fix the possible incompatibilities
2019-10-13 21:52:56 +00:00
## Contributing
2019-10-13 16:53:26 +00:00
2019-10-13 21:52:56 +00:00
All contributions are welcome!
2019-10-13 16:53:26 +00:00
2019-10-16 16:22:39 +00:00
> To add more sites, just extend src/sites/index.js
2019-10-13 21:52:56 +00:00
## Building
2019-10-13 16:53:26 +00:00
2019-10-13 21:52:56 +00:00
- Install `nodejs` and `npm`
- Clone or download this repository
- Run `cd path/to/cloned/repo`
- Run `npm install -g yarn`
- Run `yarn install`
- Create a file named `.env` with these contents:
```
PORT=3000
TSC_COMPILE_ON_ERROR=true
INLINE_RUNTIME_CHUNK=false
```
- To load the extension:
- Run `yarn run build`
- Go to `about:debugging` (FireFox)
- Click on *“Load Temporary Add-on”* and select the `manifest.json` file found inside the `build` folder.