Caller ID Monitor

A professional, white-label caller ID monitoring tool built with FastAPI and modern web technologies.

Features

• Modern, responsive UI built with Tailwind CSS
• Real-time phone number monitoring using callerapi.com
• Easy API key configuration
• Professional phone number management
• Enterprise-ready architecture following SOLID principles
• White-label ready for customization

Tech Stack

• FastAPI - Modern, fast web framework for building APIs
• SQLAlchemy - SQL toolkit and ORM
• Tailwind CSS - Utility-first CSS framework
• Jinja2 - Template engine
• SQLite - Database (can be easily switched to PostgreSQL for production)

Setup

1. Clone the repository:

git clone <repository-url>
cd caller-id-monitor

2. Create a virtual environment and activate it:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies:

pip install -r requirements.txt

4. Create a .env file in the root directory:

cp .env.example .env

5. Get your API key from https://callerapi.com/dashboard and add it to the .env file:

CALLER_API_KEY=your_api_key_here

6. Run the application:

uvicorn app.main:app --reload

7. Open your browser and navigate to http://localhost:8000

Project Structure

caller_id_monitor/
├── app/
│   ├── api/            # API endpoints
│   ├── core/           # Core configuration
│   ├── db/             # Database configuration
│   ├── models/         # SQLAlchemy models
│   ├── schemas/        # Pydantic schemas
│   ├── services/       # Business logic
│   └── templates/      # HTML templates
├── static/             # Static files
├── tests/              # Test suite
├── .env.example        # Environment variables example
└── requirements.txt    # Python dependencies

API Documentation

Once the application is running, you can access:

• Interactive API documentation: http://localhost:8000/docs
• Alternative API documentation: http://localhost:8000/redoc

Development

To run the development server with auto-reload:

uvicorn app.main:app --reload

Production Deployment

For production deployment:

1. Use a production-grade database (e.g., PostgreSQL)
2. Set up proper environment variables
3. Use a production ASGI server (e.g., Gunicorn with Uvicorn workers)
4. Set up proper security measures (HTTPS, rate limiting, etc.)
5. Configure proper logging

Example production command:

gunicorn app.main:app -w 4 -k uvicorn.workers.UvicornWorker

White Labeling

The application is designed to be easily white-labeled:

1. Customize the branding in app/templates/base.html
2. Modify the color scheme in the Tailwind configuration
3. Add your logo and custom styles
4. Update text and messaging throughout the templates

Support

For support, please contact https://callerapi.com/contact