diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..6d746b5 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,117 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Project Overview + +MSR Mod is a browser extension that provides an alternate frontend for Monster Siren Records (monster-siren.hypergryph.com). It's built with Vue 3, TypeScript, and Tailwind CSS, designed to work as both Chrome and Firefox extensions. + +## Common Commands + +### Development +```bash +npm run dev # Start development server with Vite +npm run dev:refresh # Build and refresh dist folder for extension development +npm i # Install dependencies +``` + +### Building +```bash +npm run build:chrome # Build for Chrome/Chromium browsers +npm run build:firefox # Build for Firefox +npm run build # Default build (Chrome) +``` + +### Code Quality +```bash +npm run lint # Format code with Biome +npm run quality-check # Run Biome CI checks +npm run qc # Alias for quality-check +``` + +### Extension Development Workflow +1. Run `npm run dev:refresh` to build initial dist folder +2. Load the `dist` folder as an unpacked extension in browser +3. Use `npm run dev` for hot-reload development +4. Use `npm run build:watch` for continuous builds + +## Architecture + +### Core Technologies +- **Vue 3** with Composition API and `