Developers

Contributions are greatly appreciated! Read our contributing guidelines and feel free to get started.

Getting Started

Prerequisites

You should be able to build this project from any platform as long as Docker is installed.

Install Docker

• Linux
• Windows
  1. Enable WSL.
  2. Follow the Linux installation instructions from within WSL.

Build

1. Clone the repo.
2. Run the build:

   ./npm

   or

   npm run clean-verify

The userscript will be located at build/release/script.user.js once the build completes.

Live Editing

1. Launch the watch-build and server containers:

   ./watch-build-server

2. Navigate to localhost:8080/script.user.js.

Debugging

Enable debug mode by clicking Enable Debug Mode from the userscript menu. Muted posts will appear with a dashed red border, and extra information will be printed to the web console. To view console messages, open the web console and filter by the script name.

---

Developer Documentation