https://github.com/aboutcode-org/what-to-click-browser-extension
https://github.com/aboutcode-org/what-to-click-browser-extension
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aboutcode-org/what-to-click-browser-extension
- Owner: aboutcode-org
- License: gpl-3.0
- Created: 2024-12-16T10:36:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-31T15:26:55.000Z (about 1 year ago)
- Last Synced: 2025-02-14T22:31:53.066Z (11 months ago)
- Language: HTML
- Homepage:
- Size: 19.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
What-to-click browser extension
> [!NOTE]
> This is a fork of https://github.com/what-to-click/browser-extension.
Tired of showing your teammates what to click in yet another web-based service added to your project? Worry not, you can now generate a step-by-step documentation of the workflow as you go! Start recording, go through the workflow, and adjust descriptions if necessary.
## Development Setup
Run these commands, starting from a git clone of [https://github.com/aboutcode-org/what-to-click-browser-extension.git](https://github.com/aboutcode-org/what-to-click-browser-extension.git).
- Create a development environment and install dependencies
```bash
make dev
```
- Activate the Node virtual environment
```bash
source nenv/bin/activate
```
- Run the extension in Firefox
```bash
web-ext run -s src/
```
> [!IMPORTANT]
> This will not work with Firefox installed through Snap. Make sure you have a standard Firefox installation.
## How to use
1. Visit the page you want to document.
1. Click the "red circle" browser action to start recording.
1. Perform necessary actions on the page. Each click will be recorded.
1. Click the "red square" browser action to stop recording.
1. A page with editable text will be opened, containing all of the steps you have performed with screenshots attached. Edit step descriptions to your liking and export or save the file.
## Get the addon
[Get Firefox Addon](https://addons.mozilla.org/firefox/addon/what-to-click/)