aidan/beesrv
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add testing docs for webui

Browse Source
This commit is contained in:
Aidan 2025-04-15 00:03:24 -04:00
parent 5cfffb2ec2
commit 6a941074a9
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -11,6 +11,14 @@ A KernelSU module which simplifies the installation of a keybox.xml file by fetc
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! 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
```bash
cd module/webroot # Make sure you are in webroot
bun install # Or NPM
bun start # Start the server
```
## 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. 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.
@ -23,7 +31,7 @@ This project prioritizes support for [Bun](https://bun.sh) over NPM. These instr
bun install bun install
``` ```
To run: ### Running the Server
```bash ```bash
bun run index.ts bun run index.ts
@ -31,7 +39,7 @@ bun run index.ts
### Applying DB Changes ### Applying DB Changes
``` ```bash
bunx drizzle-kit push bunx drizzle-kit push
``` ```