Files
brightwheel-exporter/README.md
T

72 lines
3.9 KiB
Markdown

# Brightwheel Memories & Reports Exporter Chrome Extension
A Chrome Extension (Manifest V3) that allows parents and guardians to bulk export all of their children's memories, high-resolution photos, videos, daily care reports (meals, naps, potty), learning milestones, and activity manifests from Brightwheel into an organized offline ZIP archive.
## ✨ Features
- **Full Data Manifest**: Exports complete student records, activities, and teacher notes in structured `manifest.json` format.
- **High-Resolution Media**: Downloads original full-size photos and videos organized neatly by year and month (`/YYYY/MM/photos/` & `.../videos/`).
- **Daily Care Logs**: Captures meal entries, nap start/end times and durations, diaper/potty logs, and medication logs.
- **Learning Milestones**: Backs up developmental milestones, curriculum tags, and teacher observations.
- **Attendance & Communication**: Includes check-in/out records, health screenings, and message history.
- **Spreadsheet Ready**: Generates an `activities.csv` spreadsheet compatible with Microsoft Excel, Numbers, and Google Sheets.
- **Offline Interactive Timeline Viewer**: Bundles a standalone `index.html` inside the exported ZIP so you can browse your child's photos, search captions, and filter events locally on your computer with no internet required.
- **Safe & Private**: Runs 100% locally in your browser. Seamlessly uses your active Brightwheel logged-in session cookies without asking for passwords or transmitting your family's data to third parties.
- **Smart Rate-Limiting**: Includes automatic exponential backoff (handling HTTP 429 throttling) and configurable pacing delays.
---
## 🚀 Installation (Load Unpacked in Chrome)
1. Open Google Chrome and navigate to `chrome://extensions/`.
2. Turn **ON** the **Developer mode** toggle in the top-right corner.
3. Click the **Load unpacked** button in the top-left corner.
4. Select this directory:
```
/Users/haopengzhan/Documents/MyGit/brightwheel-exporter-chrome-extension
```
5. The **Brightwheel Memories & Reports Exporter** icon will now appear in your Chrome toolbar!
---
## 📖 How to Use
1. Log into your Brightwheel account in Chrome at [https://schools.mybrightwheel.com](https://schools.mybrightwheel.com).
2. Navigate to your child's feed page (e.g. `https://schools.mybrightwheel.com/students/edda433b-2a24-4da7-bbd5-9f131b4b2565/feed`).
3. Click the **Brightwheel Exporter** icon in your browser toolbar (or click the floating **"Export Brightwheel Data"** button on the bottom right of the page).
4. Click **Open Exporter Dashboard**.
5. In the Dashboard:
- Select your child (or enter a custom student UUID).
- Choose your date range (**All Time**, **This Year**, or **Custom**).
- Select the content categories and export formats you want.
- Click **Start Complete Export**.
6. The extension will automatically harvest activities, download media with live progress tracking, and generate your downloadable ZIP archive!
---
## 📁 Exported Archive Structure
Inside the downloaded `.zip` file, you will find:
```
[ChildName]_[YYYY-MM-DD]/
├── index.html # Offline interactive timeline viewer
├── manifest.json # Complete raw structured data
├── activities.csv # Spreadsheet for Excel / Google Sheets
├── photos/
│ ├── 2026-08/
│ │ ├── 2026-08-20_abc123.jpg
│ │ └── ...
│ └── 2026-07/
└── videos/
└── 2026-08/
└── 2026-08-15_xyz789.mp4
```
---
## 🔒 Privacy & Security
- **Zero Data Collection**: This extension does not send any personal data, photos, credentials, or cookies to external servers. All requests happen strictly between your browser and Brightwheel/AWS S3.
- **Local Packaging**: The ZIP compression and HTML viewer creation happen entirely in your local browser memory using client-side JSZip.