https://github.com/barrymun/rust-web-extension

A template for building a web extension with Rust
https://github.com/barrymun/rust-web-extension

rust web-extension webassembly

Last synced: 10 days ago
JSON representation

A template for building a web extension with Rust

• Host: GitHub
• URL: https://github.com/barrymun/rust-web-extension
• Owner: barrymun
• License: mit
• Created: 2024-01-11T08:54:55.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-01-15T16:40:40.000Z (12 months ago)
• Last Synced: 2024-11-07T00:27:12.434Z (about 2 months ago)
• Topics: rust, web-extension, webassembly
• Language: Rust
• Homepage:
• Size: 63.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rust WebAssembly Extension

This is a web extension which is written in Rust and then compiled to WebAssembly.

## Prerequisites

Before using this extension, ensure that you have the following software installed:

- `Rust`

- `Cargo`

- `wasm-pack`

## Installation

1. Clone this repository to your local machine

2. Change into the project directory

3. Run the following command to set up the pre-commit hook:

   - `make prepare`

   This will add the pre-commit file to the ".git/hooks" directory, ensuring code quality and formatting checks before committing.

## Usage

You can test this WebAssembly extension on example.com. Follow these steps:

1. Build the WebAssembly module:

   - `make build-chromium`

2. A `dist` directory will appear at the root level.

3. Navigate to chrome://extensions and ensure that "Developer mode" is enabled.

4. Click the "Load unpacked" button and select the contents of the `dist` directory.

5. Navigate to example.com to test.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## TODO

- [x] support Firefox addons