🎱 Billiard University Scoring System

CI badge auto-filled from git remote origin: acheraga/billiard-university-app.

https://billiarduniversity.org/testing/exams/

A Vue 3 + TypeScript application for scoring and tracking Billiard University exams.

✨ Recent Updates

• ✅ TypeScript Migration - Full TypeScript conversion with type safety
• ✅ GitHub Copilot Ready - Optimized for AI-assisted development
• ✅ Enhanced Documentation - JSDoc comments on all major functions
• ✅ Developer Experience - VS Code settings and extensions configured

📚 Documentation

• MIGRATION_TYPESCRIPT.md - TypeScript migration guide
• COPILOT_SETUP.md - GitHub Copilot configuration
• .github/copilot-instructions.md - Project-specific AI instructions

Quick Start

1. Install dependencies:

npm install

2. Run development server:

npm run dev

3. Open http://localhost:3000
   • http://localhost:5173/billiard-university-app/

Features

• Complete Exam I & II scoring
• Real-time calculations
• Score history tracking
• Export functionality
• Responsive design

Project Structure

billiard-university-app/
├── src/
│   ├── components/     # Vue components (TypeScript)
│   ├── store/         # Pinia state management
│   ├── types/         # TypeScript type definitions
│   ├── utils/         # Utilities
│   └── assets/        # Styles & images
├── tests/             # Vitest unit tests
├── .vscode/           # VS Code configuration
├── .github/           # GitHub workflows & Copilot instructions
└── index.html         # Entry point

🤖 AI-Assisted Development

This project is optimized for GitHub Copilot:

• Custom Instructions: Project-specific coding patterns in .github/copilot-instructions.md
• Type Safety: Full TypeScript support with JSDoc documentation
• Smart Suggestions: Context-aware completions for Vue, Pinia, and TypeScript
• VS Code Integration: Pre-configured settings for optimal Copilot experience

See COPILOT_SETUP.md for complete setup guide.

📄 License

This software is licensed under the MIT License - see the LICENSE file for details.

📋 Exam Content Rights

All exam content, images, and assessment materials are © BilliardUniversity.org:

• Exam I & II specifications and scoring criteria
• All images in public/exam2_images/ and src/assets/exam1_figs/
• Layout diagrams and skill descriptions

These materials are provided for use with this software only. Use outside this application requires permission from BilliardUniversity.org.

🙏 Acknowledgments

• Built with assistance from DeepSeek AI Assistant
• Built with assistance from Copilot AI Assistant
• Based on the original Billiard University scoring system
• Icons by Font Awesome
• Built with Vue.js

---

🤖 AI Assistance

This project was developed with the assistance of DeepSeek AI and Copilot Assistant, which helped with:

• Vue.js 3 application architecture
• Scoring logic implementation
• Component design and structure
• Deployment configuration for GitHub Pages

Note: While AI assistance was used in development, all code decisions and implementations were reviewed and adapted for this specific use case.