diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index f007164..a65b213 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -27,6 +27,7 @@ jobs: # ============================================================ - name: Log in to GHCR run: | + echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io \ echo "${{ secrets.GHCR_PAT }}" | docker login ghcr.io \ -u "${{ github.actor }}" --password-stdin diff --git a/README.md b/README.md index ac600be..7a357c1 100644 --- a/README.md +++ b/README.md @@ -1,1014 +1,165 @@
-# ๐Ÿฆ NeuroBank FastAPI Toolkit +### โšก๐ŸŸช **GLITCH-TITLE: _Exploit to Karpathy_** +### **Neiland โ€ข NeuroBank FastAPI Toolkit** -

- NeuroBank Logo -

+โ–ˆโ–ˆโ–ˆโ–“โ–’โ–‘โ–‘ EXPLOIT TO KARPATHY โ–‘โ–‘โ–’โ–“โ–ˆโ–ˆโ–ˆ +โ–ˆโ–ˆโ–“โ–’โ–‘ NEUROBANK FASTAPI TOOLKIT โ–‘โ–’โ–“โ–ˆโ–ˆ +โ–ˆโ–“โ–’โ–‘ ARCHITECTURE โ€ข SECURITY โ€ข AI โ–‘โ–’โ–“โ–ˆ +โ–“โ–’โ–‘โ–‘ โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ โ–‘โ–‘โ–’โ–“ +โ–’โ–‘โ–‘ SYSTEMS FOR THE FUTURE โ–‘โ–‘โ–’ -### ๐Ÿš€ **Enterprise-Grade Banking Administration Platform** -### โญ *Production-Ready FastAPI Application with Modern Admin Dashboard* +Copiar cรณdigo +INITIALIZING GLITCH-PROTOCOL... +SIGNAL STABLE... +LOADING NEUROBANK ENGINE โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–’ 99% -

- ๐ŸŽฏ Designed specifically to impress Banking Industry Recruiters
- Showcasing Enterprise-Level Python/FastAPI Development Skills -

+yaml +Copiar cรณdigo ---- - -### ๐Ÿ† **Technical Excellence Badges** - -[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg?style=for-the-badge&logo=python)](https://www.python.org/downloads/) -[![FastAPI](https://img.shields.io/badge/FastAPI-0.104.1-009688.svg?style=for-the-badge&logo=fastapi)](https://fastapi.tiangolo.com) -[![Production Ready](https://img.shields.io/badge/production-ready-brightgreen.svg?style=for-the-badge&logo=checkmarx)](./deploy_production.sh) -[![Docker](https://img.shields.io/badge/docker-ready-blue.svg?style=for-the-badge&logo=docker)](./docker-compose.prod.yml) - -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT) -[![Code Quality](https://img.shields.io/badge/code%20quality-A+-brightgreen.svg?style=for-the-badge&logo=codeclimate)](./app/) -[![Security](https://img.shields.io/badge/security-verified-green.svg?style=for-the-badge&logo=security)](./app/auth/) -[![Tests](https://img.shields.io/badge/tests-passing-success.svg?style=for-the-badge&logo=github-actions)](./tests/) - ---- - -### ๐ŸŽช **Quick Access - Start in 30 Seconds!** - - - - - - - - -
- -๐ŸŽฎ **[LIVE DEMO](#-live-access-points)**
-*Interactive Dashboard* - -
- -๐Ÿ“Š **[API DOCS](#-api-endpoints)**
-*Swagger Interface* - -
- -๐Ÿš€ **[QUICK DEPLOY](#quick-start)**
-*One-Click Setup* - -
- -๐Ÿ“ฑ **[FEATURES](#key-features)**
-*Technical Showcase* - -
- ---- - -### ๐ŸŽจ **Professional Banking Dashboard Preview** - -
- -``` -โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” -โ”‚ ๐Ÿฆ NeuroBank Admin Dashboard โ”‚ -โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค -โ”‚ ๐Ÿ“Š METRICS ๐Ÿ’ณ TRANSACTIONS ๐Ÿ‘ฅ USERS โ”‚ -โ”‚ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”‚ -โ”‚ โ”‚ Total: 156 โ”‚ โ”‚ Pending: 12 โ”‚ โ”‚ Active: 89 โ”‚ โ”‚ -โ”‚ โ”‚ Volume: $42Kโ”‚ โ”‚ Failed: 3 โ”‚ โ”‚ New: 15 โ”‚ โ”‚ -โ”‚ โ”‚ Success:98.7โ”‚ โ”‚ Success:141 โ”‚ โ”‚ Blocked: 2 โ”‚ โ”‚ -โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ”‚ -โ”‚ โ”‚ -โ”‚ ๐Ÿ“ˆ REAL-TIME CHARTS ๏ฟฝ TRANSACTION SEARCH ๐Ÿ“‹ QUICK ACTIONS โ”‚ -โ”‚ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”‚ -โ”‚ โ”‚ โ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–€โ–€โ–€โ–€โ–€โ–€ โ”‚ โ”‚ [Search....... ]โ”‚ โ”‚ โšก Export Data โ”‚ โ”‚ -โ”‚ โ”‚ โ–ˆโ–ˆโ–ˆโ–ˆโ–€โ–€ โ”‚ โ”‚ Status: All โ–ผ โ”‚ โ”‚ ๐Ÿ“Š Generate Rpt โ”‚ โ”‚ -โ”‚ โ”‚ โ–ˆโ–ˆโ–€โ–€ โ”‚ โ”‚ Type: All โ–ผ โ”‚ โ”‚ ๐Ÿ”„ Sync System โ”‚ โ”‚ -โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ โ”‚ -โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ -``` - -**๏ฟฝ Interactive Features:** Real-time Updates โ€ข Advanced Filtering โ€ข Mobile Responsive โ€ข Chart.js Integration - -
- -

- ๐Ÿ† Enterprise-Level Features: - Real-time Analytics โ€ข Transaction Management โ€ข User Administration โ€ข Security Layer โ€ข Production Deploy -

- ---- - -### โšก **30-Second Demo Setup** - -```bash -# ๐Ÿš€ One command to impress recruiters! -git clone https://github.com/Neiland85/NeuroBank-FastAPI-Toolkit.git -cd NeuroBank-FastAPI-Toolkit && git checkout develop -chmod +x deploy_production.sh && ./deploy_production.sh - -# ๐ŸŽ‰ Open browser: http://localhost:8000/backoffice/ -``` - -
-๐ŸŽฏ Perfect for live coding interviews & technical presentations!
--- -### ๐Ÿ“Š **Project Statistics** - -
- -| ๐Ÿ“ˆ **Metric** | ๐ŸŽฏ **Value** | ๐Ÿ’ก **Impact** | -|---|---|---| -| **Lines of Code** | 2,000+ | Professional codebase | -| **API Endpoints** | 15+ | Comprehensive backend | -| **UI Components** | 20+ | Modern dashboard | -| **Docker Ready** | โœ… | Production deployment | -| **Security Layer** | โœ… | Banking-grade auth | -| **Real-time Features** | โœ… | Live data updates | -| **Mobile Responsive** | โœ… | Professional UI/UX | -| **Documentation** | 100% | Enterprise standard | +# ๐Ÿง  About the Project -
+**NeuroBank FastAPI Toolkit** is a modular, secure, audit-ready backend framework designed for fintech, banking, and critical infrastructure environments. Built with a security-first mindset and industrial-grade CI/CD. -
+This toolkit isnโ€™t just an API. +Itโ€™s a **way of building systems**. --- -## ๐Ÿ“‹ **Navigation Menu** - -
- -### ๐ŸŽฏ **Core Sections** -[๐ŸŽฏ Project Overview](#project-overview) โ€ข [โœจ Key Features](#key-features) โ€ข [๐Ÿ—๏ธ Architecture](#architecture) โ€ข [๐Ÿš€ Quick Start](#quick-start) - -### ๐Ÿ“Š **Technical Details** -[๐Ÿ”— Live Access Points](#live-access-points) โ€ข [๐Ÿ“ฑ Dashboard Preview](#dashboard-preview) โ€ข [๐Ÿ”ง Technical Stack](#technical-stack) โ€ข [๐Ÿ“‚ Project Structure](#project-structure) - -### ๐Ÿš€ **Deployment & Operations** -[๐ŸŒ API Endpoints](#api-endpoints) โ€ข [๐Ÿš€ Production Deployment](#production-deployment) โ€ข [๐Ÿงช Testing & Development](#testing--development) - -### ๐Ÿ“ˆ **Advanced Topics** -[๐Ÿ“Š Monitoring & Health](#-monitoring--health) โ€ข [๐Ÿ”’ Security Features](#-security-features) โ€ข [๐Ÿ“ˆ Performance](#-performance) โ€ข [๐ŸŽจ UI/UX Design](#-uiux-design) - -### ๐Ÿ“š **Resources** -[๐Ÿ“– Documentation](#-documentation) โ€ข [๐Ÿค Contributing](#-contributing) - -
- ---- - -## ๐ŸŽฏ **Project Overview** - -
- -### ๐Ÿ† **The Ultimate Banking Tech Showcase** - -
- -**NeuroBank FastAPI Toolkit** es una aplicaciรณn bancaria de **nivel empresarial** diseรฑada especรญficamente para **impresionar a reclutadores tรฉcnicos de la industria bancaria**. - -๐ŸŽช **Este proyecto demuestra:** -- โœ… **Habilidades Python/FastAPI avanzadas** con patrones async/await -- โœ… **Arquitectura de microservicios** production-ready -- โœ… **Dashboard administrativo completo** con UI moderna -- โœ… **Mejores prรกcticas de seguridad** para fintech -- โœ… **DevOps y deployment** automatizado -- โœ… **Testing y monitoreo** profesional - -### ๏ฟฝ **ยฟPor quรฉ elegir este proyecto para impresionar?** - -
- -| ๐Ÿฆ **Banking Focus** | ๐Ÿš€ **Tech Excellence** | ๐Ÿ’ผ **Professional Level** | -|---|---|---| -| Real banking workflows | Modern FastAPI stack | Enterprise architecture | -| Financial data handling | Async/await patterns | Production deployment | -| Security best practices | API documentation | Monitoring & logging | -| Transaction management | Docker containerization | CI/CD ready | - -
- -### ๐ŸŽช **Technical Journey Map** - -```mermaid -graph TD - A[๐ŸŽฏ Objetivo] --> B[Impresionar Reclutadores Bancarios] - B --> C[Demostrar Habilidades Enterprise] - B --> D[Showcase Tรฉcnico Completo] - B --> E[Aplicaciรณn Production-Ready] - - C --> C1[๐Ÿ”ง Backend APIs] - C --> C2[๐ŸŽจ Frontend Moderno] - C --> C3[๐Ÿš€ DevOps & Deploy] - C --> C4[๐Ÿ”’ Security Best Practices] - - D --> D1[๐Ÿ“Š Real-time Dashboard] - D --> D2[๐Ÿ’ณ Transaction Management] - D --> D3[๐Ÿ‘ฅ User Administration] - D --> D4[๐Ÿ“ˆ Data Visualization] -``` - ---- - -## โœจ **Key Features** - - - - - - -
- -### ๐Ÿฆ **Banking Dashboard** -- โœ… Professional banking UI/UX -- โœ… Real-time metrics & analytics -- โœ… Interactive data visualization -- โœ… Mobile-responsive design -- โœ… Modern Bootstrap 5 theme - -### ๐Ÿ’ณ **Transaction Management** -- โœ… Advanced filtering & search -- โœ… Pagination & sorting -- โœ… CSV/Excel export functionality -- โœ… Real-time status updates -- โœ… Bulk operations support - - - -### ๐Ÿ”ง **Technical Excellence** -- โœ… FastAPI async/await patterns -- โœ… Pydantic data validation -- โœ… OpenAPI/Swagger documentation -- โœ… Production-ready architecture -- โœ… Docker containerization - -### ๐Ÿš€ **DevOps Ready** -- โœ… Multi-environment deployment -- โœ… Health checks & monitoring -- โœ… Nginx reverse proxy -- โœ… Systemd service integration -- โœ… CI/CD pipeline ready - -
- ---- - -## ๐Ÿ—๏ธ **Architecture** - -```mermaid -graph TB - subgraph "๐ŸŒ Client Layer" - UI[๐ŸŽจ Modern Web UI
Bootstrap 5 + Chart.js] - Mobile[๐Ÿ“ฑ Responsive Design
Mobile-First] - end - - subgraph "๐Ÿ”€ Load Balancer" - Nginx[๐ŸŒ Nginx Reverse Proxy
SSL + Security Headers] - end - - subgraph "๐Ÿš€ Application Layer" - FastAPI[โšก FastAPI Backend
Async/Await + Pydantic] - Jinja[๐ŸŽญ Jinja2 Templates
Server-Side Rendering] - end - - subgraph "๐Ÿ’พ Data Layer" - SQLite[(๐Ÿ—„๏ธ SQLite Database
Transaction Data)] - Mock[๐ŸŽฒ Mock Data Generator
Demo Purposes] - end - - subgraph "๐Ÿ“Š Monitoring" - Health[๐Ÿฅ Health Checks] - Metrics[๐Ÿ“ˆ Metrics API] - Logs[๐Ÿ“‹ Structured Logging] - end - - UI --> Nginx - Mobile --> Nginx - Nginx --> FastAPI - FastAPI --> Jinja - FastAPI --> SQLite - FastAPI --> Mock - FastAPI --> Health - FastAPI --> Metrics - FastAPI --> Logs - - style FastAPI fill:#1e3a8a,stroke:#fff,color:#fff - style UI fill:#3b82f6,stroke:#fff,color:#fff - style Nginx fill:#10b981,stroke:#fff,color:#fff -``` - ---- - -## ๐Ÿš€ **Quick Start** - -### ๐ŸŽฎ **Option 1: One-Click Demo** *(Recommended)* - -```bash -# 1. Clone the repository -git clone https://github.com/Neiland85/NeuroBank-FastAPI-Toolkit.git -cd NeuroBank-FastAPI-Toolkit - -# 2. Switch to develop branch -git checkout develop - -# 3. One-click production deployment -chmod +x deploy_production.sh -./deploy_production.sh - -# ๐ŸŽ‰ Done! Access: http://localhost:8000/backoffice/ -``` - -### ๐Ÿณ **Option 2: Docker** *(Production)* - -```bash -# Quick Docker deployment -docker-compose -f docker-compose.prod.yml up -d - -# Access dashboard: http://localhost:8000/backoffice/ -``` - -### ๐Ÿ **Option 3: Manual Setup** *(Development)* - -```bash -# 1. Install dependencies -pip install -r requirements.txt - -# 2. Start development server -uvicorn app.main:app --reload --host 0.0.0.0 --port 8000 - -# 3. Open browser: http://localhost:8000/backoffice/ -``` - ---- - -## ๐Ÿ”— **Live Access Points** - -Una vez que el servidor estรฉ ejecutรกndose, puedes acceder a: - -### ๐ŸŽฏ **Dashboard Sections** - -| ๐ŸŽช **Section** | ๐Ÿ”— **URL** | ๐Ÿ“ **Description** | ๐ŸŽฏ **File** | -|---|---|---|---| -| ๐Ÿ  **Main Dashboard** | [localhost:8000/backoffice/](http://localhost:8000/backoffice/) | Panel principal con mรฉtricas | [`app/backoffice/router.py:55`](./app/backoffice/router.py#L55) | -| ๐Ÿ’ณ **Transactions** | [localhost:8000/backoffice/admin/transactions](http://localhost:8000/backoffice/admin/transactions) | Gestiรณn de transacciones | [`app/backoffice/router.py:155`](./app/backoffice/router.py#L155) | -| ๐Ÿ‘ฅ **Users** | [localhost:8000/backoffice/admin/users](http://localhost:8000/backoffice/admin/users) | Administraciรณn de usuarios | [`app/backoffice/router.py:167`](./app/backoffice/router.py#L167) | -| ๐Ÿ“ˆ **Reports** | [localhost:8000/backoffice/admin/reports](http://localhost:8000/backoffice/admin/reports) | Reportes financieros | [`app/backoffice/router.py:179`](./app/backoffice/router.py#L179) | - -### ๐Ÿ”ง **API Endpoints** - -| ๐ŸŽช **API** | ๐Ÿ”— **URL** | ๐Ÿ“ **Description** | ๐ŸŽฏ **File** | -|---|---|---|---| -| ๐Ÿ“Š **Metrics API** | [localhost:8000/backoffice/api/metrics](http://localhost:8000/backoffice/api/metrics) | Mรฉtricas en tiempo real | [`app/backoffice/router.py:66`](./app/backoffice/router.py#L66) | -| ๐Ÿ” **Search API** | [localhost:8000/backoffice/api/transactions/search](http://localhost:8000/backoffice/api/transactions/search) | Bรบsqueda de transacciones | [`app/backoffice/router.py:84`](./app/backoffice/router.py#L84) | -| ๐Ÿฅ **Health Check** | [localhost:8000/health](http://localhost:8000/health) | Estado del sistema | [`app/main.py:85`](./app/main.py#L85) | -| ๐Ÿ“– **API Docs** | [localhost:8000/docs](http://localhost:8000/docs) | Swagger UI | *FastAPI Auto-generated* | - ---- +# ๐Ÿš€ Tech Stack -## ๐Ÿ“ฑ **Dashboard Preview** - -### ๐ŸŽจ **Modern Banking Interface** - -```mermaid -graph LR - subgraph "๐Ÿ–ฅ๏ธ Main Dashboard" - A[๐Ÿ“Š Real-time Metrics
- Transactions: 156
- Volume: $42,350
- Success Rate: 98.7%] - B[๐Ÿ“ˆ Interactive Charts
- Transaction Trends
- Volume Analysis
- Status Distribution] - C[๐Ÿ”” System Health
- API Status
- Response Time
- Uptime Monitor] - end - - subgraph "๐Ÿ’ณ Transaction Panel" - D[๐Ÿ” Advanced Filters
- Status Filter
- Date Range
- Amount Range
- User Search] - E[๐Ÿ“‹ Data Table
- Sortable Columns
- Pagination
- Bulk Actions
- Export Options] - F[๐ŸŽฏ Quick Actions
- View Details
- Edit Transaction
- Status Update
- Generate Report] - end - - A --> D - B --> E - C --> F - - style A fill:#1e3a8a,stroke:#fff,color:#fff - style D fill:#10b981,stroke:#fff,color:#fff - style B fill:#3b82f6,stroke:#fff,color:#fff -``` - -### ๐ŸŽฏ **Key UI Components** - -| ๐ŸŽจ **Component** | ๐Ÿ“‚ **Template File** | โœจ **Features** | -|---|---|---| -| **Main Dashboard** | [`app/backoffice/templates/basic_dashboard.html`](./app/backoffice/templates/basic_dashboard.html) | Real-time metrics, animated counters, charts | -| **Transaction Table** | [`app/backoffice/templates/admin_transactions.html`](./app/backoffice/templates/admin_transactions.html) | Filtering, pagination, export | -| **Navigation** | *Included in templates* | Responsive menu, breadcrumbs | -| **Charts & Graphs** | *Chart.js integration* | Interactive data visualization | +| Layer | Technology | +|------|------------| +| API Framework | FastAPI 0.116.x | +| Runtime | Python **3.11.8** | +| Config | Pydantic v2 + SettingsConfigDict | +| Telemetry | Structured logging, startup/shutdown hooks | +| CI/CD | GitHub Actions: lint, tests, security, docker | +| Security | CodeQL, Trivy, GitGuardian | +| Docker | Multi-stage, slim, non-root | --- -## ๐Ÿ”ง **Technical Stack** - -
- -### **๐Ÿ—๏ธ Backend Architecture** - -[![FastAPI](https://img.shields.io/badge/FastAPI-009688?style=for-the-badge&logo=fastapi&logoColor=white)](https://fastapi.tiangolo.com/) -[![Python](https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white)](https://python.org) -[![Pydantic](https://img.shields.io/badge/Pydantic-E92063?style=for-the-badge&logo=pydantic&logoColor=white)](https://pydantic.dev) -[![SQLite](https://img.shields.io/badge/SQLite-003B57?style=for-the-badge&logo=sqlite&logoColor=white)](https://sqlite.org) - -### **๐ŸŽจ Frontend & UI** - -[![Bootstrap](https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white)](https://getbootstrap.com) -[![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black)](https://developer.mozilla.org/en-US/docs/Web/JavaScript) -[![Chart.js](https://img.shields.io/badge/Chart.js-FF6384?style=for-the-badge&logo=chartdotjs&logoColor=white)](https://chartjs.org) -[![Jinja2](https://img.shields.io/badge/Jinja2-B41717?style=for-the-badge&logo=jinja&logoColor=white)](https://jinja.palletsprojects.com) - -### **๐Ÿš€ DevOps & Deployment** - -[![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)](https://docker.com) -[![Nginx](https://img.shields.io/badge/Nginx-009639?style=for-the-badge&logo=nginx&logoColor=white)](https://nginx.org) -[![Gunicorn](https://img.shields.io/badge/Gunicorn-499848?style=for-the-badge&logo=gunicorn&logoColor=white)](https://gunicorn.org) - -
- -### ๐Ÿ“Š **Technical Specifications** +# ๐Ÿ›ก Security-First Architecture +### โœ” CodeQL deep analysis +### โœ” Trivy container & dependency scanning +### โœ” Secret scanning enforcement +### โœ” Explicitly documented host binding ```python -# Core Dependencies - requirements.txt -fastapi==0.104.1 # โšก Modern web framework -uvicorn[standard]==0.24.0 # ๐Ÿš€ ASGI server -jinja2==3.1.3 # ๐ŸŽญ Template engine -python-multipart==0.0.9 # ๐Ÿ“ค File upload support -pydantic==2.5.0 # โœ… Data validation -``` - -| **๐Ÿ”ง Component** | **๐Ÿ“‚ Implementation** | **๐ŸŽฏ Purpose** | -|---|---|---| -| **Main App** | [`app/main.py`](./app/main.py) | FastAPI application setup, middleware, routing | -| **Dashboard Router** | [`app/backoffice/router.py`](./app/backoffice/router.py) | Admin panel endpoints and business logic | -| **Templates** | [`app/backoffice/templates/`](./app/backoffice/templates/) | Jinja2 HTML templates with Bootstrap 5 | -| **Authentication** | [`app/auth/dependencies.py`](./app/auth/dependencies.py) | API key authentication system | -| **Utilities** | [`app/utils/`](./app/utils/) | Logging, helpers, and common functions | - ---- - -## ๐Ÿ“‚ **Project Structure** - -``` -๐Ÿฆ NeuroBank-FastAPI-Toolkit/ -โ”‚ -โ”œโ”€โ”€ ๐Ÿ“ฑ app/ # Main application -โ”‚ โ”œโ”€โ”€ ๐Ÿ  main.py # FastAPI app configuration -โ”‚ โ”œโ”€โ”€ ๐Ÿ” auth/ # Authentication system -โ”‚ โ”‚ โ””โ”€โ”€ dependencies.py # API key verification -โ”‚ โ”œโ”€โ”€ ๐ŸŽฏ backoffice/ # Admin dashboard -โ”‚ โ”‚ โ”œโ”€โ”€ ๐Ÿ”— router.py # Dashboard routes & APIs -โ”‚ โ”‚ โ””โ”€โ”€ ๐ŸŽจ templates/ # HTML templates -โ”‚ โ”‚ โ”œโ”€โ”€ basic_dashboard.html # Main dashboard -โ”‚ โ”‚ โ”œโ”€โ”€ admin_transactions.html # Transaction management -โ”‚ โ”‚ โ””โ”€โ”€ dashboard.html # Advanced dashboard -โ”‚ โ”œโ”€โ”€ ๐Ÿ“Š routers/ # API routers -โ”‚ โ”‚ โ””โ”€โ”€ operator.py # Banking operations -โ”‚ โ””โ”€โ”€ ๐Ÿ› ๏ธ utils/ # Utilities -โ”‚ โ””โ”€โ”€ logging.py # Structured logging -โ”‚ -โ”œโ”€โ”€ ๐Ÿš€ deploy_production.sh # One-click deployment -โ”œโ”€โ”€ ๐Ÿณ docker-compose.prod.yml # Production Docker setup -โ”œโ”€โ”€ ๐Ÿ”ง start_production.sh # Production startup script -โ”œโ”€โ”€ โš™๏ธ neurobank-fastapi.service # Systemd service -โ”œโ”€โ”€ ๐ŸŒ nginx/nginx.conf # Reverse proxy config -โ”‚ -โ”œโ”€โ”€ ๐Ÿ“‹ requirements.txt # Python dependencies -โ”œโ”€โ”€ ๐Ÿ“– README.md # This amazing documentation -โ”œโ”€โ”€ ๐Ÿ“„ PRODUCTION_README.md # Production deployment guide -โ”œโ”€โ”€ ๐Ÿ”ข VERSION # Semantic versioning -โ”‚ -โ””โ”€โ”€ ๐Ÿ—ƒ๏ธ data/ # Database & logs - โ””โ”€โ”€ app.log # Application logs -``` - -### **๐ŸŽฏ Key Files Deep Dive** - -| **๐Ÿ“„ File** | **๐ŸŽช Lines** | **๐ŸŽฏ Key Functions** | **๐Ÿ’ก Description** | -|---|---|---|---| -| [`app/main.py`](./app/main.py) | 241 lines | `create_app()`, CORS setup | Main FastAPI application with middleware | -| [`app/backoffice/router.py`](./app/backoffice/router.py) | 200+ lines | Dashboard routes, APIs | Complete admin panel backend | -| [`deploy_production.sh`](./deploy_production.sh) | 300+ lines | Production deployment | Automated deployment script | -| [`templates/basic_dashboard.html`](./app/backoffice/templates/basic_dashboard.html) | 400+ lines | Dashboard UI | Professional banking interface | - ---- - -## ๐ŸŒ **API Endpoints** - -### ๐Ÿ“Š **Backoffice Dashboard APIs** - -```mermaid -graph TD - subgraph "๐ŸŽฏ Dashboard Endpoints" - A[๐Ÿ  GET /backoffice/] --> A1[๐Ÿ“Š Main Dashboard] - B[๐Ÿ’ณ GET /backoffice/admin/transactions] --> B1[๐Ÿ’ผ Transaction Management] - C[๐Ÿ‘ฅ GET /backoffice/admin/users] --> C1[๐Ÿ‘ค User Administration] - D[๐Ÿ“ˆ GET /backoffice/admin/reports] --> D1[๐Ÿ“‹ Financial Reports] - end - - subgraph "๐Ÿ”ง Data APIs" - E[๐Ÿ“Š GET /backoffice/api/metrics] --> E1[๐Ÿ“ˆ Real-time Metrics] - F[๐Ÿ” GET /backoffice/api/transactions/search] --> F1[๐Ÿ”Ž Transaction Search] - G[๐Ÿฅ GET /backoffice/api/system-health] --> G1[โค๏ธ System Health] - H[โ„น๏ธ GET /backoffice/info] --> H1[๐Ÿ“‹ System Information] - end - - style A fill:#1e3a8a,stroke:#fff,color:#fff - style E fill:#10b981,stroke:#fff,color:#fff -``` - -### **๐ŸŽฏ Endpoint Details** - -
-๐Ÿ  Dashboard Endpoints - -#### **Main Dashboard** -```http -GET /backoffice/ -``` -- **File**: [`app/backoffice/router.py:55`](./app/backoffice/router.py#L55) -- **Template**: [`basic_dashboard.html`](./app/backoffice/templates/basic_dashboard.html) -- **Features**: Real-time metrics, animated counters, system health - -#### **Transaction Management** -```http -GET /backoffice/admin/transactions -``` -- **File**: [`app/backoffice/router.py:155`](./app/backoffice/router.py#L155) -- **Features**: Advanced filtering, pagination, export functionality - -
- -
-๐Ÿ”ง API Endpoints - -#### **Real-time Metrics** -```http -GET /backoffice/api/metrics -``` -- **Response**: -```json -{ - "total_transactions": 156, - "total_volume": 42350.00, - "active_accounts": 89, - "success_rate": 98.7, - "avg_response_time": 67.3, - "api_calls_today": 642 -} -``` - -#### **Transaction Search** -```http -GET /backoffice/api/transactions/search?page=1&page_size=20&status=completed -``` -- **Parameters**: `query`, `status`, `transaction_type`, `page`, `page_size` -- **Response**: Paginated transaction list with metadata - -
- ---- - -## ๐Ÿš€ **Production Deployment** - -### **๐ŸŽฏ Deployment Architecture** - -```mermaid -graph TD - subgraph "โ˜๏ธ Production Environment" - LB[๐ŸŒ Load Balancer
Nginx + SSL] - - subgraph "๐Ÿš€ Application Servers" - APP1[โšก FastAPI Instance 1
Gunicorn + Uvicorn] - APP2[โšก FastAPI Instance 2
Gunicorn + Uvicorn] - APP3[โšก FastAPI Instance 3
Gunicorn + Uvicorn] - end - - subgraph "๐Ÿ’พ Data Layer" - DB[(๐Ÿ—„๏ธ SQLite Database)] - CACHE[(๐Ÿ”„ Redis Cache)] - end - - subgraph "๐Ÿ“Š Monitoring" - HEALTH[๐Ÿฅ Health Checks] - METRICS[๐Ÿ“ˆ Metrics Collection] - LOGS[๐Ÿ“‹ Centralized Logging] - end - end - - LB --> APP1 - LB --> APP2 - LB --> APP3 - APP1 --> DB - APP2 --> DB - APP3 --> DB - APP1 --> CACHE - APP2 --> CACHE - APP3 --> CACHE - - APP1 --> HEALTH - APP2 --> METRICS - APP3 --> LOGS - - style LB fill:#10b981,stroke:#fff,color:#fff - style APP1 fill:#1e3a8a,stroke:#fff,color:#fff - style APP2 fill:#1e3a8a,stroke:#fff,color:#fff - style APP3 fill:#1e3a8a,stroke:#fff,color:#fff -``` - -### **๐ŸŽช Deployment Options** - -| **๐Ÿš€ Method** | **โšก Command** | **๐ŸŽฏ Best For** | **๐Ÿ“„ Config File** | -|---|---|---|---| -| **๐Ÿณ Docker** | `docker-compose -f docker-compose.prod.yml up -d` | Production | [`docker-compose.prod.yml`](./docker-compose.prod.yml) | -| **๐Ÿ”ง Direct** | `./start_production.sh` | Development/Testing | [`start_production.sh`](./start_production.sh) | -| **โš™๏ธ Systemd** | `sudo systemctl start neurobank-fastapi` | Linux Servers | [`neurobank-fastapi.service`](./neurobank-fastapi.service) | -| **๐ŸŽฏ One-Click** | `./deploy_production.sh` | Full Setup | [`deploy_production.sh`](./deploy_production.sh) | - -### **๐Ÿ”ง Production Configuration** - -
-๐Ÿณ Docker Production Setup - -```yaml -# docker-compose.prod.yml -version: '3.8' -services: - neurobank-api: - build: - context: . - dockerfile: Dockerfile.prod - ports: - - "8000:8000" - environment: - - APP_ENV=production - - LOG_LEVEL=info - restart: unless-stopped - - nginx: - image: nginx:alpine - ports: - - "80:80" - - "443:443" - depends_on: - - neurobank-api -``` - -
- -
-โš™๏ธ Environment Variables - -```bash -# .env.prod - Production Environment -APP_NAME=NeuroBank FastAPI Toolkit -APP_VERSION=1.0.0 -ENVIRONMENT=production -DEBUG=false -LOG_LEVEL=info -HOST=0.0.0.0 -PORT=8000 -WORKERS=4 -``` - -
- ---- - -## ๐Ÿงช **Testing & Development** - -### **๐Ÿ”ฌ Running Tests** - -```bash -# Install test dependencies -pip install pytest pytest-asyncio httpx - -# Run all tests +# nosec B104 +uvicorn.run(app, host="0.0.0.0") +๐Ÿงฌ Config System (Pydantic v2) +python +Copiar cรณdigo +class Settings(BaseSettings): + model_config = SettingsConfigDict( + env_file=".env", + extra="ignore" + ) + app_name: str = "neurobank" + environment: str = "local" +Load order: + +Defaults + +.env + +.env.test (pytest only) + +System env + +CI overrides + +๐Ÿ“Š Telemetry Module +python +Copiar cรณdigo +@app.on_event("startup") +async def startup_telemetry(): + logger.info("๐Ÿ“ก Telemetry initialized") + +@app.on_event("shutdown") +async def shutdown_telemetry(): + logger.info("๐Ÿ“ก Telemetry shutdown complete") +Migration to modern FastAPI lifespan mode is planned. + +๐Ÿณ Docker (Secure Multi-Stage) +dockerfile +Copiar cรณdigo +FROM python:3.11-slim AS builder +... + +FROM python:3.11-slim +USER appuser +CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0"] +๐Ÿ” CI/CD Summary +Lint +black + +isort + +Test pytest -# Run with coverage -pytest --cov=app --cov-report=html - -# Run specific test file -pytest tests/test_backoffice.py -v -``` - -### **๐Ÿ› ๏ธ Development Setup** - -```bash -# 1. Clone and setup -git clone https://github.com/Neiland85/NeuroBank-FastAPI-Toolkit.git -cd NeuroBank-FastAPI-Toolkit - -# 2. Create virtual environment -python -m venv venv -source venv/bin/activate # Linux/Mac -# venv\Scripts\activate # Windows - -# 3. Install dependencies -pip install -r requirements.txt - -# 4. Start development server -uvicorn app.main:app --reload --host 0.0.0.0 --port 8000 - -# 5. Open browser -open http://localhost:8000/backoffice/ -``` - -### **๐ŸŽฏ Development Workflow** - -```mermaid -graph LR - A[๐Ÿ‘จโ€๐Ÿ’ป Code Changes] --> B[๐Ÿงช Local Testing] - B --> C[๐Ÿ”„ Git Commit] - C --> D[๐Ÿ“ค Push to Feature Branch] - D --> E[๐Ÿ” Pull Request Review] - E --> F[โœ… Merge to Develop] - F --> G[๐Ÿš€ Deploy to Production] - - style A fill:#3b82f6,stroke:#fff,color:#fff - style G fill:#10b981,stroke:#fff,color:#fff -``` - ---- - -## ๐Ÿ“Š **Monitoring & Health** - -### **๐Ÿฅ Health Check System** - -| **๐Ÿ” Endpoint** | **๐Ÿ“Š Metrics** | **๐ŸŽฏ Purpose** | -|---|---|---| -| [`/health`](http://localhost:8000/health) | System status, uptime, response time | Load balancer health checks | -| [`/backoffice/api/system-health`](http://localhost:8000/backoffice/api/system-health) | Database, cache, API gateway status | Detailed system monitoring | -| [`/backoffice/api/metrics`](http://localhost:8000/backoffice/api/metrics) | Business metrics, transaction stats | Real-time dashboard data | - -### **๐Ÿ“ˆ Monitoring Dashboard** - -```mermaid -graph TB - subgraph "๐Ÿ“Š Metrics Collection" - A[โšก API Response Times] - B[๐Ÿ’ณ Transaction Volumes] - C[๐Ÿ‘ฅ Active Users] - D[๐Ÿ’พ Database Health] - E[๐Ÿ”„ Cache Performance] - end - - subgraph "๐ŸŽฏ Monitoring Tools" - F[๐Ÿ“ˆ Grafana Dashboards] - G[๐Ÿšจ Alerting System] - H[๐Ÿ“‹ Log Aggregation] - I[๐Ÿ” Performance Profiling] - end - - A --> F - B --> F - C --> G - D --> H - E --> I - - style F fill:#1e3a8a,stroke:#fff,color:#fff - style G fill:#ef4444,stroke:#fff,color:#fff -``` - ---- - -## ๐Ÿ”’ **Security Features** - -### **๐Ÿ›ก๏ธ Security Implementation** - -| **๐Ÿ”’ Feature** | **๐Ÿ“‚ Implementation** | **๐ŸŽฏ Protection** | -|---|---|---| -| **API Key Authentication** | [`app/auth/dependencies.py`](./app/auth/dependencies.py) | Endpoint protection | -| **CORS Configuration** | [`app/main.py:45`](./app/main.py#L45) | Cross-origin security | -| **Input Validation** | Pydantic models | Data integrity | -| **SQL Injection Prevention** | ORM usage | Database security | -| **Security Headers** | [`nginx/nginx.conf`](./nginx/nginx.conf) | HTTP security | - -### **๐Ÿ” Authentication Flow** - -```mermaid -sequenceDiagram - participant C as ๐Ÿ‘ค Client - participant A as ๐Ÿ” Auth Middleware - participant B as โšก Backend API - participant D as ๐Ÿ’พ Database - - C->>A: Request with API Key - A->>A: Validate API Key - alt โœ… Valid Key - A->>B: Forward Request - B->>D: Database Query - D->>B: Return Data - B->>C: โœ… Success Response - else โŒ Invalid Key - A->>C: โŒ 401 Unauthorized - end -``` - ---- - -## ๐Ÿ“ˆ **Performance** - -### **โšก Performance Metrics** - -| **๐ŸŽฏ Metric** | **๐Ÿ“Š Target** | **๐Ÿ” Current** | **๐Ÿ› ๏ธ Optimization** | -|---|---|---|---| -| **API Response Time** | < 100ms | ~67ms | โœ… Async/await patterns | -| **Database Queries** | < 50ms | ~23ms | โœ… Optimized queries | -| **Page Load Time** | < 2s | ~1.2s | โœ… CDN + caching | -| **Concurrent Users** | 1000+ | Tested 500+ | โœ… Async FastAPI | -| **Memory Usage** | < 512MB | ~180MB | โœ… Efficient data structures | - -### **๐Ÿš€ Performance Optimizations** - -```mermaid -graph LR - subgraph "โšก Backend Optimizations" - A[๐Ÿ”„ Async/Await
FastAPI + Uvicorn] - B[๐Ÿ“Š Data Validation
Pydantic Models] - C[๐Ÿ’พ Connection Pooling
Database Optimization] - end - - subgraph "๐ŸŽจ Frontend Optimizations" - D[๐Ÿ“ฆ CDN Assets
Bootstrap + Chart.js] - E[๐Ÿ—œ๏ธ Minified Code
CSS + JavaScript] - F[๐Ÿ–ผ๏ธ Lazy Loading
Images + Components] - end - - subgraph "๐ŸŒ Infrastructure" - G[๐Ÿ”„ Load Balancing
Nginx Proxy] - H[๐Ÿ’จ Gzip Compression
Static Assets] - I[โšก HTTP/2 Support
Modern Protocol] - end - - A --> D - B --> E - C --> F - D --> G - E --> H - F --> I - - style A fill:#10b981,stroke:#fff,color:#fff - style D fill:#3b82f6,stroke:#fff,color:#fff - style G fill:#1e3a8a,stroke:#fff,color:#fff -``` - ---- - -## ๐ŸŽจ **UI/UX Design** - -### **๐ŸŽช Design System** - -
- -#### **๐ŸŽจ Color Palette** - -
- -| **Primary** | **Secondary** | **Success** | **Warning** | **Danger** | -|-------------|---------------|-------------|-------------|------------| -| ![#1e3a8a](https://img.shields.io/badge/-%231e3a8a-1e3a8a?style=flat-square&logoColor=white) | ![#3b82f6](https://img.shields.io/badge/-%233b82f6-3b82f6?style=flat-square&logoColor=white) | ![#10b981](https://img.shields.io/badge/-%2310b981-10b981?style=flat-square&logoColor=white) | ![#f59e0b](https://img.shields.io/badge/-%23f59e0b-f59e0b?style=flat-square&logoColor=white) | ![#ef4444](https://img.shields.io/badge/-%23ef4444-ef4444?style=flat-square&logoColor=white) | -| `#1e3a8a` | `#3b82f6` | `#10b981` | `#f59e0b` | `#ef4444` | - -**Banking Theme** โ€ข **Professional Trust** โ€ข **Accessibility Compliant** - -
- -
- -| **๐ŸŽจ Component** | **๐ŸŽฏ Purpose** | **๐Ÿ“ฑ Responsive** | **โœจ Features** | -|---|---|---|---| -| **Navigation Bar** | Site navigation | โœ… Mobile-first | Collapsible menu, active states | -| **Metrics Cards** | Key statistics | โœ… Grid layout | Animated counters, hover effects | -| **Data Tables** | Transaction lists | โœ… Horizontal scroll | Sorting, filtering, pagination | -| **Charts & Graphs** | Data visualization | โœ… Responsive canvas | Interactive tooltips, zoom | -| **Forms** | Data input | โœ… Validation states | Real-time validation, error messages | - -### **๐Ÿ“ฑ Responsive Design** - -```mermaid -graph TD - subgraph "๐Ÿ“ฑ Mobile (< 768px)" - A[๐Ÿ”„ Stacked Layout
Single Column] - B[โ˜ฐ Hamburger Menu
Collapsible Navigation] - C[๐Ÿ“Š Simplified Charts
Touch-Friendly] - end - - subgraph "๐Ÿ’ป Tablet (768px - 1024px)" - D[๐Ÿ“ฆ Grid Layout
2-Column Design] - E[๐Ÿ“‹ Side Navigation
Expanded Menu] - F[๐Ÿ“ˆ Full Charts
Interactive Elements] - end - - subgraph "๐Ÿ–ฅ๏ธ Desktop (> 1024px)" - G[๐ŸŽฏ Full Layout
Multi-Column Grid] - H[๐ŸŽช Rich Navigation
All Features Visible] - I[๐Ÿ“Š Advanced Charts
All Interactions] - end - - A --> D --> G - B --> E --> H - C --> F --> I - - style A fill:#ef4444,stroke:#fff,color:#fff - style D fill:#f59e0b,stroke:#fff,color:#fff - style G fill:#10b981,stroke:#fff,color:#fff -``` - ---- - -## ๐Ÿ“– **Documentation** - -### **๐Ÿ“š Documentation Structure** - -| **๐Ÿ“„ Document** | **๐ŸŽฏ Purpose** | **๐Ÿ‘ฅ Audience** | -|---|---|---| -| [`README.md`](./README.md) | Project overview & quick start | Developers, Recruiters | -| [`PRODUCTION_README.md`](./PRODUCTION_README.md) | Production deployment guide | DevOps, Sysadmins | -| [API Docs](http://localhost:8000/docs) | Interactive API documentation | API Consumers | -| [Code Comments](./app/) | Inline code documentation | Developers | - -### **๐ŸŽฏ API Documentation** - -The application provides **comprehensive API documentation** through: - -- **๐Ÿš€ FastAPI Auto-generated Docs**: [localhost:8000/docs](http://localhost:8000/docs) -- **๐Ÿ“‹ ReDoc Interface**: [localhost:8000/redoc](http://localhost:8000/redoc) -- **๐Ÿ“Š OpenAPI Schema**: [localhost:8000/openapi.json](http://localhost:8000/openapi.json) - ---- +Python 3.11 & 3.12 matrix -## ๐Ÿค **Contributing** +Security +Trivy -### **๐ŸŽฏ Development Workflow** +GitGuardian -```bash -# 1. Fork the repository -git fork https://github.com/Neiland85/NeuroBank-FastAPI-Toolkit.git +CodeQL -# 2. Create feature branch -git checkout -b feature/amazing-new-feature +Deploy +Railway deploy temporarily disabled due to upstream installer issue. -# 3. Make changes and commit -git commit -m "โœจ Add amazing new feature" +๐Ÿงช Development +bash +Copiar cรณdigo +pyenv local 3.11.8 +python -m venv .venv +source .venv/bin/activate -# 4. Push to your fork -git push origin feature/amazing-new-feature - -# 5. Create Pull Request -# Use the PR templates provided in the repository -``` - -### **๐Ÿ“‹ Code Standards** - -| **๐ŸŽฏ Standard** | **๐Ÿ› ๏ธ Tool** | **๐Ÿ“„ Config** | -|---|---|---| -| **Python Code Style** | Black, isort | `pyproject.toml` | -| **Type Checking** | mypy | `mypy.ini` | -| **Linting** | flake8, pylint | `.flake8` | -| **Testing** | pytest | `pytest.ini` | -| **Documentation** | Sphinx | `docs/conf.py` | - ---- - -
- -## ๐ŸŽ‰ **Ready to Impress Banking Recruiters!** - -### **๐Ÿš€ Quick Demo Access** - -```bash -git clone https://github.com/Neiland85/NeuroBank-FastAPI-Toolkit.git -cd NeuroBank-FastAPI-Toolkit -./deploy_production.sh -``` - -**๐ŸŽฏ Dashboard**: [http://localhost:8000/backoffice/](http://localhost:8000/backoffice/) - ---- - -### **๐Ÿ“ž Contact & Links** - -[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://linkedin.com/in/your-profile) -[![GitHub](https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Neiland85) -[![Portfolio](https://img.shields.io/badge/Portfolio-FF5722?style=for-the-badge&logo=web&logoColor=white)](https://your-portfolio.com) - ---- - -**Built with โค๏ธ for Banking Industry Recruitment** - -*Showcasing Enterprise-Level Python/FastAPI Development Skills* - ---- - -โญ **Star this repository if it helped you!** +pip install -r requirements.txt +uvicorn app.main:app --reload +Tests: + +bash +Copiar cรณdigo +pytest -q +Format: + +bash +Copiar cรณdigo +black app +isort app +๐Ÿ—‚ Project Structure +arduino +Copiar cรณdigo +app/ +โ”œโ”€โ”€ api/ +โ”œโ”€โ”€ core/ +โ”œโ”€โ”€ config.py +โ”œโ”€โ”€ telemetry.py +tests/ +.github/workflows/ +Dockerfile +requirements.txt +๐Ÿงญ Roadmap +Reintegration of Railway deploy once fixed upstream + +FastAPI lifespan migration + +OpenAI dossier integration + +Expand config/test coverage + +โญ Final Note +This toolkit is built with surgical precision, obsessive correctness, and a hackerโ€™s discipline. +It isnโ€™t a backend. +Itโ€™s a statement. -
NeuroBank-FastAPI-Toolkit -Seniorโ€‘grade FastAPI microservice blueprint for AIโ€‘driven banking. Pythonโ€ฏ3.10+, Pydanticโ€ฏv2, Docker & AWS stack (Lambda, AppRunner, CloudWatch, Xโ€‘Ray) with CI/CD via GitHubโ€ฏActions. Incluye clean code, tests completos, observabilidad y mรณdulos listos para estado de pedidos, facturaciรณn y analรญtica. -# Trigger deployment