Skip to content

vikhyatsingh123/TrailSteps

Repository files navigation

🚀 TrailSteps - Chrome Extension

TrailSteps is a Chrome Extension that captures every interaction you perform on a website, turns them into editable steps in a sidebar panel, and lets you export them as a structured PDF.
Think of it as a lightweight, open-source alternative to Tango.


🧠 Features

  • 📌 Tracks all clicks and interactions across any website
  • 📝 Displays recorded steps in a clean sidebar UI (built with React + AntD)
  • 🧹 Edit, delete, or reorder steps before export
  • 📄 Submit to open a new PDF generation page
  • 🖨️ Download your step-by-step guide as a PDF

✅ Use Cases

  • Creating tutorials and SOPs
  • QA/testing documentation
  • Internal process guides
  • Bug reproduction steps
  • Onboarding workflows

🛠️ Tech Stack


📁 Project Structure

trailsteps/
├── public/
│   ├── pdf.html            # HTML entry for PDF React page
│   └── icons/              # Extension icons
├── src/
│   ├── content/            # contentScript.ts - DOM tracking logic
│   ├── background/         # background.ts - event routing & tab handling
│   ├── sidepanel/          # React sidebar UI (Vite + AntD + Tailwind)
│   ├── pdfview/            # React PDF view page for export
│   └── manifest.json       # Chrome extension configuration
├── vite.config.ts
└── README.md

🧪 Development Notes

  • Click tracking starts when the user clicks Start in the side panel.
  • Steps are stored in local extension state (Zustand, chrome.storage.local).
  • On submission, a new tab (pdf.html) opens and renders the tracked steps.
  • PDF can be generated using html2canvas + jsPDF or html2pdf.js.

📦 Load in Chrome

  1. Run yarn build
  2. Go to chrome://extensions
  3. Enable Developer Mode
  4. Click Load Unpacked
  5. Select the dist/ folder

🚀 Getting Started

1. Clone the repo

git clone https://github.com/vikhyatsingh123/TrailSteps.git
cd trailsteps

2. Install dependencies

yarn install

3. Run in dev mode

yarn dev

4. Build for production

yarn build

About

Interactive DAP chrome extension

Topics

Resources

License

Stars

Watchers

Forks

Contributors