This client module has been primarially written for KernelSU. I test the module with the latest version of KernelSU-Next. Community testing and support for other root providers is encouraged!

Testing WebUI Locally

cd module/webroot # Make sure you are in webroot
bun install # Or NPM
bun start # Start the server

Server

To create a server which is capable of serving the files to a client (user of the module), this will require a server. You can set one up below with minimal effort.

Installing Dependencies

This project prioritizes support for Bun over NPM. These instructions are written for bun, although they could be adapted.

bun install

Running the Server

bun run index.ts

Applying DB Changes

bunx drizzle-kit push

Serving Files

A beebox.xml file should be placed the server/serve/ directory. You will have to create this directory.

Credits

Thank you to all of the people and projects I have come across while building this! Without you, this project wouldn't be a reality.

Re-Malwack by ZG089 - This helped me so much while writing the module
KernelSU Documentation - Very helpful resource for building a complete module
rootAVD by newbit - Very useful tool to root an emulator with Magisk, which I used for testing

Languages

HTML 26.8%

JavaScript 22.8%

CSS 21.6%

TypeScript 15.4%

Shell 13.4%