Mask My Text

A privacy-focused text masking tool that works entirely in your browser. Uses WebAssembly and Rust.

Development Setup

1. Clone the repository:

   git clone https://github.com/richardjypark/maskmytext.com.git
   cd maskmytext.com

2. Install dependencies:

   rustup target add wasm32-unknown-unknown

   wasm-pack build

   cd www
   pnpm install

3. Run the project:

   pnpm run dev

Testing

To run tests, use the following command:

wasm-pack test --headless --chrome

cd www
pnpm test

Run only frontend unit tests:

cd www
pnpm run test:unit

Run only Playwright end-to-end tests:

cd www
pnpm run test:e2e

Deployment

The application is automatically built, tested, and deployed to GitHub Pages whenever the master branch is updated. The workflow responsible for this lives at .github/workflows/deploy.yml.

Quick deploy

1. Make sure all tests pass locally (wasm-pack test --headless --chrome and pnpm test inside www).
2. Commit your changes and push (or merge a pull-request) to master.
3. Watch the Actions → Build, Test, and Deploy workflow – it will:
   • Check out the repository and restore caches
   • Build the Rust → WebAssembly package (wasm-pack build --release)
   • Run Rust and Playwright tests
   • Build the production bundle (pnpm build:prod)
   • Publish the www/dist folder to GitHub Pages
4. When the workflow finishes successfully your changes will be live at https://maskmytext.com (or the GitHub Pages URL for forks).

Manual redeploy

Need to redeploy without new commits? Open Actions → Build, Test, and Deploy → Run workflow to trigger the pipeline manually (enabled by the workflow_dispatch event).

License

MIT