From 7c93ac56ffd09609c7ebd0e617a5e52a30ad254b Mon Sep 17 00:00:00 2001 From: Francisco de Guzman <17106076+franciszver@users.noreply.github.com> Date: Fri, 24 Jul 2026 20:54:59 -0700 Subject: [PATCH] docs: live CI/CodeQL badges + true counts, drop vanity/stale claims (#72) Replace 4 hand-written vanity badges (production-ready, tests-354, API-64, version-1.0.0) with live GitHub Actions CI and CodeQL badges. Reword the stale '354 tests' claims to derived language (CI-verified). Correct the Project Statistics endpoint/handler count to true values (60+ REST endpoints across 14 route-handler modules). Remove both 'Production Ready' self-labels. Presentation-only; no code changes. Closes #72 Assisted-by: Claude Code (sonnet subagent) Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01JgJgXbhqnBB89y4yL6ZJVk --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e4a810d..ac9d3da 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,8 @@ **ElevareAI** is a comprehensive AI-powered tutoring platform that supports students between sessions with adaptive practice, conversational Q&A, personalized nudges, and progress tracking. -[![Status](https://img.shields.io/badge/status-production%20ready-green)]() -[![Tests](https://img.shields.io/badge/tests-354%20passing-brightgreen)]() -[![API](https://img.shields.io/badge/API-64%20endpoints-blue)]() -[![Version](https://img.shields.io/badge/version-1.0.0-orange)]() +[![CI](https://github.com/franciszver/ElevareAI/actions/workflows/ci.yml/badge.svg)](https://github.com/franciszver/ElevareAI/actions/workflows/ci.yml) +[![CodeQL](https://github.com/franciszver/ElevareAI/actions/workflows/codeql.yml/badge.svg)](https://github.com/franciszver/ElevareAI/actions/workflows/codeql.yml) ![ElevareAI demo](docs/assets/demo.gif) *A quick tour: sign in, dashboard, AI Q&A with math rendering, adaptive practice, goals, and progress.* @@ -136,7 +134,7 @@ docker-compose down - **AI/LLM**: OpenRouter (free-tier openai/gpt-oss-20b:free model) - **Authentication**: Self-hosted JWT (bcrypt via passlib + HS256 via python-jose) - **Email**: Disabled (log-only no-op; no external email provider) -- **Testing**: Pytest (354 tests) +- **Testing**: Pytest (CI-verified suite) - **Logging**: Structlog - **Validation**: Pydantic 2.5 @@ -556,7 +554,7 @@ pytest --cov=src tests/ ``` ### Test Coverage -- **354 tests** covering all features +- **Comprehensive automated tests** covering all features - Unit tests for services and models - Integration tests for complete workflows - Edge case coverage for practice, progress, and Q&A @@ -750,7 +748,7 @@ PennyGadget/ │ ├── logging_config.py # Logging setup │ ├── metrics.py # Metrics utilities │ └── cache.py # Caching utilities -├── tests/ # Test suite (354 tests) +├── tests/ # Test suite (CI-verified) │ ├── test_api_endpoints.py # API endpoint tests │ ├── test_models.py # Model tests │ ├── test_practice_edge_cases.py # Practice edge cases @@ -829,8 +827,8 @@ See `_docs/NEXT_STEPS.md` for detailed next steps. ## 📊 Project Statistics -- **API Endpoints**: 64+ endpoints across 12 route handlers -- **Test Coverage**: 354 tests passing +- **API Endpoints**: 60+ REST endpoints across 14 route-handler modules +- **Test Coverage**: CI-verified (see Actions) - **Services**: 20+ service modules across 8 service categories - **Database Models**: 15+ SQLAlchemy models - **Frontend Pages**: 9 complete React pages @@ -877,7 +875,6 @@ The only requirement is to include the license and copyright notice. ## 🎉 Status **✅ All Features Implemented** -**✅ Production Ready** **✅ Fully Documented** **✅ Ready for Next Phase**