gsadmin/KoalaSync
1
0
Fork 0
mirror of https://github.com/Shik3i/KoalaSync.git synced 2026-08-07 18:03:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: clean up obsolete scripts and update documentation for store readiness

Browse Source
This commit is contained in:
MacBook
2026-05-04 04:37:59 +02:00
parent fa4e4039b3
commit 0f1f8bde1b
4 changed files with 1189 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/README.md
+21
View File
@@ -0,0 +1,21 @@
# Development Scripts
This directory contains utility scripts for the KoalaSync development workflow.
## build-extension.js
The primary build tool for KoalaSync. This Node.js script automates two critical tasks:
1. **Protocol Synchronization**: Copies the "Single Source of Truth" constants (`shared/constants.js`) and the domain blacklist (`shared/blacklist.js`) from the root `/shared` directory into the `extension/shared/` directory.
2. **Artifact Generation**: Compiles the extension into browser-specific bundles for Chrome and Firefox, located in the `dist/` directory.
### Usage
From the **repository root**, run:
```bash
node scripts/build-extension.js
```
### Why this script exists
KoalaSync uses **Vanilla JS** in the extension to maintain zero runtime dependencies and maximum privacy. Since we don't use a bundler (like Webpack or Vite) inside the extension, this script serves as our lightweight "pre-build" step to ensure that the protocol constants remain synchronized between the extension and the relay server.