Skip to content

mfyuu/reading-list

Repository files navigation

Reading List

English | Japanese

A Chrome extension for saving articles and web pages to read later, built with Lit Web Components and TypeScript.

Reading List extension screenshot

Installation from Chrome Web Store

Install from Chrome Web Store

Features

  • Save articles and web pages for later reading
  • Quick access through browser popup
  • Context menu integration
  • Clean and modern UI using Lit components

Tech Stack

  • Frontend: Lit Web Components 3.3.1
  • Language: TypeScript (ES2022)
  • Build Tool: Vite
  • Package Manager: Bun
  • Testing: Vitest + Playwright
  • Linting: Biome

Installation

Prerequisites

  • Bun (required)
  • Chrome browser

Setup

# Install dependencies
bun install

Development

# Build for production
bun run build

# Run tests
bun run test

# Check code quality
bun check

Building the Extension

bun run build

The built extension will be in the dist/ directory.

Loading in Chrome (for development)

  1. Open Chrome and go to chrome://extensions/
  2. Enable "Developer mode"
  3. Click "Load unpacked"
  4. Select the dist/ directory

Scripts

Command Description
bun run build Build for production
bun preview Preview built app
bun check Run format and lint checks
bun format Format code
bun lint Check for lint errors
bun lint:fix Auto-fix lint errors
bun check-types TypeScript type checking
bun run test Run tests
bun run test:watch Run tests in watch mode
bun run test:list List all available tests
bun run test:ui Open Vitest UI
bun run test:coverage Run tests with coverage
bun run package Build and create extension zip

License

MIT

About

A Chrome extension to save articles and web pages for later reading, built with Lit Web Components and TypeScript.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published