https://github.com/mskelton/scholar
A Chrome extension that helps you track your progress when reading docs
https://github.com/mskelton/scholar
chrome-extension documentation education learning progress-tracker scholar
Last synced: 12 days ago
JSON representation
A Chrome extension that helps you track your progress when reading docs
- Host: GitHub
- URL: https://github.com/mskelton/scholar
- Owner: mskelton
- License: isc
- Created: 2025-07-29T12:19:23.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-10-14T21:40:31.000Z (7 months ago)
- Last Synced: 2026-04-18T09:08:49.558Z (about 1 month ago)
- Topics: chrome-extension, documentation, education, learning, progress-tracker, scholar
- Language: TypeScript
- Homepage: https://chromewebstore.google.com/detail/scholar/aanobjpajhiopeemffkkkoeepkelbblk
- Size: 177 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Scholar
A Chrome extension that helps you track your progress when reading docs
## Development
### Prerequisites
- Node.js (v18 or higher)
- Yarn package manager
### Setup
1. Clone the repository
2. Install dependencies:
```bash
yarn install
```
3. Build the extension:
```bash
yarn build
```
4. Load the extension in Chrome:
- Open Chrome and go to `chrome://extensions/`
- Enable "Developer mode"
- Click "Load unpacked"
- Select the `dist` folder from this project
### Development Commands
- `yarn dev` - Start development server
- `yarn build` - Build for production
- `yarn format` - Format code with Prettier
## Permissions
The extension requires the following permissions:
- `storage` - To save your learning progress
- `tabs` - To track and manage tabs
- `activeTab` - To interact with the current tab
## Contributing
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run `yarn format` to format your code
5. Submit a pull request
## Releasing
```bash
zip -r scholar.zip 'dist/**'
```