Welcome to the technical documentation for PingMyDb. This directory contains detailed guides and references for developers, contributors, and system administrators.
- Architecture: High-level overview of the system components, data flow, and technology stack.
- API Reference: Detailed list of all RESTful endpoints, request parameters, and authentication requirements.
- Database Schema: Breakdown of the PostgreSQL relational structure, core tables, and encryption strategies.
- Deployment Guide: Instructions for hosting the frontend, backend, and monitoring workers in a production environment.
- Contributing Guide: Guidelines for local development, branching strategies, and adding support for new database types.
- FAQ: Frequently asked questions about security, features, and billing.
- /frontend: React + Vite + Tailwind (The Dashboard & Status Pages)
- /backend: Express + BullMQ + Redis (The API & Monitoring Engine)
- /docs: This directory (Technical Documentation)
This project is licensed under the MIT License - see the root directory for details.