Hikka Forge is a modular browser extension designed to inject custom features and styles into the hikka.io website. It is architected to be extensible, allowing new features (termed "Modules") to be developed and integrated with minimal boilerplate.
- Recommendations using the custom anime2vec model.
- Weekly top lists for ongoing anime
- Native Hikka weighted scores instead of MAL ratings.
- Full, searchable users comment history.
- Seasonal thematic logos.
To get a local copy up and running, follow these simple steps.
- Node.js (LTS version recommended)
- pnpm (specified as
packageManagerinpackage.json)
- Clone the repository:
git clone https://github.com/Lorg0n/hikka-forge-extension.git cd hikka-forge-extension - Install dependencies:
pnpm install
Hikka Forge uses Vite for a fast development experience with hot module replacement (HMR).
-
Build with watch mode for extension development: For browser extension development, you'll want to use the
build:watchscripts which compile the extension files directly into thedistfolder.- For Chrome:
pnpm build:watch:chrome
- For Firefox:
pnpm build:watch:firefox
These commands will watch for changes in your source code and automatically recompile the extension, allowing for quick iteration when testing in the browser.
- For Chrome:
To create a production-ready build of the extension:
-
For Chrome:
pnpm build:chrome
This will generate the extension files in the
dist/directory, optimized for Chrome. -
For Firefox:
pnpm build:firefox
This will generate the extension files in the
dist/directory, optimized for Firefox.
After building the extension (or while using build:watch):
- Open Chrome and navigate to
chrome://extensions. - Enable "Developer mode" in the top-right corner.
- Click the "Load unpacked" button.
- Navigate to the
distdirectory within your cloned project folder and select it. - The "Hikka Forge" extension should now appear in your list of extensions.
- Open Firefox and navigate to
about:debugging#/runtime/this-firefox. - Click the "Load Temporary Add-on..." button.
- Navigate to the
distdirectory within your cloned project folder. - Select the
manifest.jsonfile inside thedistfolder. - The "Hikka Forge" extension will be loaded. Note that temporary add-ons are removed when Firefox is closed. For persistent loading during development, you might want to use a tool like
web-ext run.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also open an issue with the tag "enhancement".
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Please ensure your code adheres to the existing style and pass ESLint checks.
This project is licensed under the MIT License. See the LICENSE file