Skip to content

docs: live CI/CodeQL badges + true counts, drop vanity claims (#72) #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
franciszver merged 1 commit into from
Jul 25, 2026
Merged

docs: live CI/CodeQL badges + true counts, drop vanity claims (#72) #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.*
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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**

Expand Down
Loading