mirror of
https://github.com/johndoe6345789/snippet-pastebin.git
synced 2026-04-24 13:34:55 +00:00
johndoe6345789
d2e3cef2ee
- Created comprehensive test suites for quality validator module (430+ tests) * index.test.ts: QualityValidator main module * reporters/*.test.ts: ReporterBase and all reporters * scoring/*.test.ts: Scoring engine with edge cases * utils/*.test.ts: Validators, formatters, FileChangeDetector - Added UI component tests for sidebar menu and templates (800+ tests) * SidebarMenuButton, SidebarMenuSubButton, etc. * DashboardTemplate, BlogTemplate * ContentPreviewCardsSection, FormFieldsSection - Coverage improvements: * Statements: 56.62% → 60.93% (+4.31%) * Functions: 76.76% → 79.82% (+3.06%) * Branches: 84.37% → 85.92% (+1.55%) * Tests passing: 5,512 (added 363 new passing tests) Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
CodeSnippet - Code Snippet Manager
A powerful code snippet management application with flexible storage backends and an integrated component library showcase.
🚀 Quick Start
Choose the setup that works best for you:
Option 1: Full Stack with Docker (Recommended)
docker-compose up -d
Access at: http://localhost:3000 (auto-configured with Flask backend)
Option 2: Local Development
# Start backend
docker-compose -f docker-compose.backend-only.yml up -d
# Configure frontend
echo "VITE_FLASK_BACKEND_URL=http://localhost:5000" > .env
# Start frontend
npm install
npm run dev
Access at: http://localhost:5173
Option 3: Frontend Only (No Backend)
npm install
npm run dev
Access at: http://localhost:5173 (uses local IndexedDB storage)
📖 See detailed setup instructions →
🔑 Key Features
- 📝 Snippet Management - Create, edit, and organize code snippets with syntax highlighting
- 🔍 Smart Search - Real-time search across title, description, language, and code
- 👁️ Live Preview - Split-screen editor with live React component preview
- 💾 Flexible Storage - Choose between local IndexedDB or Flask backend
- 🔄 Auto-Configuration - Automatically use Flask backend via environment variable
- 🗂️ Component Library - Showcase organized by atomic design principles
- 📤 Export/Import - Backup and restore your entire database
- 🎨 Beautiful UI - Modern dark theme with purple and cyan accents
🎯 Storage Backends
CodeSnippet supports two storage backends:
IndexedDB (Default)
- Local browser storage
- No server required
- Perfect for personal use
Flask Backend (Optional)
- Remote server storage
- Multi-device sync
- Requires Flask backend
🔧 Auto-Configuration:
Set VITE_FLASK_BACKEND_URL environment variable to automatically use Flask backend:
# .env file
VITE_FLASK_BACKEND_URL=http://localhost:5000
When set, the app automatically connects to Flask backend and disables manual configuration.
📖 Complete backend configuration guide →
📚 Documentation
Getting Started
- Quick Start Guide - Get up and running quickly
- Application Guide - Features and usage
Backend & Storage
- Backend Configuration - Detailed backend setup and environment variables
- Backend API - Flask API documentation
Production Deployment
- CI/CD Workflows - GitHub Actions workflows for GHCR and GitHub Pages
- Deployment Guide - Complete CapRover/Cloudflare deployment walkthrough
- CORS Configuration - CORS setup and troubleshooting
- Deployment Checklist - Quick deployment reference
- Docker Examples - Docker deployment options
🛠️ Technology Stack
- React 19 + TypeScript
- SQL.js (SQLite in WebAssembly)
- Flask (Python backend)
- Monaco Editor (VS Code editor)
- Framer Motion (animations)
- Shadcn UI (component library)
- Tailwind CSS (styling)
📄 License
The Spark Template files and resources from GitHub are licensed under the terms of the MIT license, Copyright GitHub, Inc.