release: v0.5.0 - Authentication, API Keys & Advanced Features
Complete v0.5.0 implementation: Database (@db-engineer): - 3 migrations: users, api_keys, report_schedules tables - Foreign keys, indexes, constraints, enums Backend (@backend-dev): - JWT authentication service with bcrypt (cost=12) - Auth endpoints: /register, /login, /refresh, /me - API Keys service with hash storage and prefix validation - API Keys endpoints: CRUD + rotate - Security module with JWT HS256 Frontend (@frontend-dev): - Login/Register pages with validation - AuthContext with localStorage persistence - Protected routes implementation - API Keys management UI (create, revoke, rotate) - Header with user dropdown DevOps (@devops-engineer): - .env.example and .env.production.example - docker-compose.scheduler.yml - scripts/setup-secrets.sh - INFRASTRUCTURE_SETUP.md QA (@qa-engineer): - 85 E2E tests: auth.spec.ts, apikeys.spec.ts, scenarios.spec.ts, regression-v050.spec.ts - auth-helpers.ts with 20+ utility functions - Test plans and documentation Architecture (@spec-architect): - SECURITY.md with best practices - SECURITY-CHECKLIST.md pre-deployment - Updated architecture.md with auth flows - Updated README.md with v0.5.0 features Documentation: - Updated todo.md with v0.5.0 status - Added docs/README.md index - Complete setup instructions Dependencies added: - bcrypt, python-jose, passlib, email-validator Tested: JWT auth flow, API keys CRUD, protected routes, 85 E2E tests ready Closes: v0.5.0 milestone
This commit is contained in:
100
docs/README.md
Normal file
100
docs/README.md
Normal file
@@ -0,0 +1,100 @@
|
||||
# mockupAWS Documentation
|
||||
|
||||
> **Versione:** v0.5.0
|
||||
> **Ultimo aggiornamento:** 2026-04-07
|
||||
|
||||
---
|
||||
|
||||
## 📚 Indice Documentazione
|
||||
|
||||
### Getting Started
|
||||
- [../README.md](../README.md) - Panoramica progetto e quick start
|
||||
- [../CHANGELOG.md](../CHANGELOG.md) - Storia versioni e cambiamenti
|
||||
|
||||
### Architecture & Design
|
||||
- [../export/architecture.md](../export/architecture.md) - Architettura sistema completa
|
||||
- [architecture.md](./architecture.md) - Schema architettura base
|
||||
- [../export/kanban-v0.4.0.md](../export/kanban-v0.4.0.md) - Task board v0.4.0
|
||||
|
||||
### Security
|
||||
- [../SECURITY.md](../SECURITY.md) - Security overview e best practices
|
||||
- [SECURITY-CHECKLIST.md](./SECURITY-CHECKLIST.md) - Pre-deployment checklist
|
||||
|
||||
### Infrastructure
|
||||
- [INFRASTRUCTURE_SETUP.md](./INFRASTRUCTURE_SETUP.md) - Setup email, cron, secrets
|
||||
- [../docker-compose.yml](../docker-compose.yml) - Docker orchestration
|
||||
- [../docker-compose.scheduler.yml](../docker-compose.scheduler.yml) - Scheduler deployment
|
||||
|
||||
### Development
|
||||
- [../todo.md](../todo.md) - Task list e prossimi passi
|
||||
- [bug_ledger.md](./bug_ledger.md) - Bug tracking
|
||||
- [../export/progress.md](../export/progress.md) - Progress tracking
|
||||
|
||||
### API Documentation
|
||||
- **Swagger UI:** http://localhost:8000/docs (quando backend running)
|
||||
- [../export/architecture.md](../export/architecture.md) - API specifications
|
||||
|
||||
### Prompts & Planning
|
||||
- [../prompt/prompt-v0.4.0-planning.md](../prompt/prompt-v0.4.0-planning.md) - Planning v0.4.0
|
||||
- [../prompt/prompt-v0.4.0-kickoff.md](../prompt/prompt-v0.4.0-kickoff.md) - Kickoff v0.4.0
|
||||
- [../prompt/prompt-v0.5.0-kickoff.md](../prompt/prompt-v0.5.0-kickoff.md) - Kickoff v0.5.0
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Quick Reference
|
||||
|
||||
### Setup Development
|
||||
```bash
|
||||
# 1. Clone
|
||||
git clone <repository-url>
|
||||
cd mockupAWS
|
||||
|
||||
# 2. Setup secrets
|
||||
./scripts/setup-secrets.sh
|
||||
|
||||
# 3. Start database
|
||||
docker-compose up -d postgres
|
||||
|
||||
# 4. Run migrations
|
||||
uv run alembic upgrade head
|
||||
|
||||
# 5. Start backend
|
||||
uv run uvicorn src.main:app --reload
|
||||
|
||||
# 6. Start frontend (altro terminale)
|
||||
cd frontend && npm run dev
|
||||
```
|
||||
|
||||
### Testing
|
||||
```bash
|
||||
# Backend tests
|
||||
cd /home/google/Sources/LucaSacchiNet/mockupAWS
|
||||
pytest
|
||||
|
||||
# Frontend E2E tests
|
||||
cd frontend
|
||||
npm run test:e2e
|
||||
|
||||
# Specific test suites
|
||||
npm run test:e2e -- auth.spec.ts
|
||||
npm run test:e2e -- apikeys.spec.ts
|
||||
```
|
||||
|
||||
### API Endpoints
|
||||
- **Health:** `GET /health`
|
||||
- **Auth:** `POST /api/v1/auth/login`, `POST /api/v1/auth/register`
|
||||
- **API Keys:** `GET /api/v1/api-keys`, `POST /api/v1/api-keys`
|
||||
- **Scenarios:** `GET /api/v1/scenarios`
|
||||
- **Reports:** `GET /api/v1/reports`, `POST /api/v1/scenarios/{id}/reports`
|
||||
|
||||
---
|
||||
|
||||
## 📞 Supporto
|
||||
|
||||
- **Issues:** GitHub Issues
|
||||
- **Documentation:** Questa directory
|
||||
- **API Docs:** http://localhost:8000/docs
|
||||
|
||||
---
|
||||
|
||||
*Per informazioni dettagliate su ogni componente, consultare i file linkati sopra.*
|
||||
Reference in New Issue
Block a user