🚀 FaitCRM - Advanced Field Service Management System

A comprehensive field service management system built on SuiteCRM with advanced features for scheduling, GPS tracking, customer portal, digital signatures, and business automation. Designed to compete with platforms like Housecall Pro.

🏗️ Architecture

┌─────────────────┐    ┌──────────────────┐    ┌─────────────────┐
│   Customer      │    │   SuiteCRM       │    │   MySQL DB      │
│   Portal        │◄──►│   + Custom APIs  │◄──►│   + Extensions  │
│   (PHP/JS)      │    │   + GPS Tracking │    │                 │
└─────────────────┘    └──────────────────┘    └─────────────────┘
         │                        │                        │
         └────────────────────────┼────────────────────────┘
                                  │
                    ┌─────────────────────────┐
                    │   External Services     │
                    │   • Google Maps API     │
                    │   • Twilio SMS          │
                    │   • SendGrid Email      │
                    │   • Cloud Storage       │
                    └─────────────────────────┘

✨ Features

📅 Advanced Scheduling & Dispatch

Drag-and-drop calendar with real-time updates
Automated technician assignment based on skills and location
Route optimization with Google Maps integration
Job templates with customizable checklists
Recurring appointment scheduling

📍 Real-time GPS Tracking

Live technician location tracking
Geofencing for job sites
ETA calculations with traffic data
Route history and mileage tracking
Customer notifications with technician location

🌐 Customer Portal

Online appointment booking with real-time availability
Service history and invoice access
Real-time technician tracking for customers
Digital signature collection for work orders
Review and rating system

📱 Mobile-Optimized Interface

Responsive design for all devices
Touch-friendly drag-and-drop scheduling
Mobile signature capture
Offline capability for critical functions
Progressive Web App features

💳 Payment Processing

Stripe integration for online payments
Invoice generation and tracking
Payment history and receipts
Automated payment reminders
Multiple payment methods

📧 Automated Communications

SMS notifications via Twilio
Email automation via Gmail SMTP
OMW (On My Way) notifications
Appointment reminders
Review request automation

🚀 Quick Start

Prerequisites

Google Cloud account with billing enabled
Google Maps API key
Twilio account (for SMS notifications)
SendGrid account (for email notifications)

Production Deployment (Google Cloud Run)

Clone the repository:

git clone https://github.com/Faitltd/faitCRM.git
cd faitCRM
git checkout faitcrm-advanced

Authenticate with Google Cloud:

gcloud auth login
gcloud config set project faitcrm

Get your API keys:
- Google Maps: https://console.cloud.google.com/apis/credentials?project=faitcrm
- Twilio: https://www.twilio.com/try-twilio
- Gmail App Password: https://myaccount.google.com/apppasswords
Deploy everything (one command):
```
./deployment/cloud-run/quick-deploy.sh
```

Set up database:

gcloud sql connect faitcrm-db --user=root
# In MySQL prompt:
source deployment/database/schema.sql
exit

Access Your System

Admin Dashboard: https://your-app-url.run.app
Customer Portal: https://your-app-url.run.app/portal
API Endpoints: https://your-app-url.run.app/Api/V8

Custom Domain Setup

To use your own domain (e.g., yourdomain.com/faitcrm), add this to your web server:

Apache:

ProxyPass /faitcrm/ https://your-cloud-run-url.run.app/
ProxyPassReverse /faitcrm/ https://your-cloud-run-url.run.app/

Nginx:

location /faitcrm/ {
    proxy_pass https://your-cloud-run-url.run.app/;
    proxy_set_header Host $host;
}

📁 Project Structure

faitCRM/
├── Api/                           # SuiteCRM API Extensions
│   └── V8/
│       └── Controller/
│           ├── HousecallProController.php    # Field service APIs
│           └── CustomerPortalController.php  # Customer portal APIs
├── custom/                        # SuiteCRM Customizations
│   ├── modules/                   # Custom modules
│   ├── Extension/                 # SuiteCRM extensions
│   └── include/                   # Custom includes
├── customer-portal/               # Customer-facing portal
│   ├── pages/                     # Portal pages
│   │   ├── dashboard.php          # Customer dashboard
│   │   ├── booking.php            # Online booking
│   │   ├── tracking.php           # Real-time tracking
│   │   ├── signature.php          # Digital signatures
│   │   └── review.php             # Review system
│   ├── assets/                    # CSS, JS, images
│   └── index.php                  # Portal entry point
├── deployment/                    # Deployment infrastructure
│   ├── cloud-run/                 # Google Cloud Run setup
│   │   ├── deploy.sh              # Main deployment script
│   │   ├── quick-deploy.sh        # One-command deployment
│   │   ├── Dockerfile             # Container configuration
│   │   └── config/                # Production config
│   ├── database/                  # Database schema
│   │   └── schema.sql             # Complete database setup
│   └── DEPLOYMENT_GUIDE.md        # Deployment instructions
├── modules/                       # SuiteCRM core modules
├── include/                       # SuiteCRM core includes
├── DEPLOY_NOW.md                  # Quick start guide
└── README.md

🔧 Configuration

Required API Keys

All sensitive configuration is stored in Google Secret Manager:

google-maps-api-key - Google Maps API key
twilio-account-sid - Twilio Account SID
twilio-auth-token - Twilio Auth Token
twilio-phone-number - Twilio phone number
gmail-username - Gmail address for SMTP
gmail-password - Gmail App Password
stripe-secret-key - Stripe secret key (optional)
db-password - Database password (auto-generated)

External Services Setup

Google Maps API:

Enable APIs: Maps JavaScript, Places, Directions, Geocoding
Get API key from Google Cloud Console
Store in Secret Manager

Twilio SMS:

Sign up at twilio.com
Get Account SID, Auth Token, and phone number
Configure for SMS notifications

Gmail SMTP:

Use your existing Gmail account
Set up App Password at myaccount.google.com/apppasswords
Configure for automated emails

💰 Cost Estimation

Monthly Operating Costs

Google Cloud Run: $10-50 (based on usage)
Cloud SQL Database: $25-100 (db-f1-micro to db-n1-standard-1)
Cloud Storage: $5-20 (file storage)
Google Maps API: $0-200 (based on usage)
Twilio SMS: $0.0075 per message
Gmail SMTP: Free with existing Gmail account

Total Estimated: $50-400/month depending on usage

🏆 Competitive Advantage

vs. Housecall Pro:

✅ No monthly per-user fees - pay only for infrastructure
✅ Complete source code ownership - full customization
✅ Advanced GPS tracking with real-time updates
✅ Integrated customer portal with online booking
✅ Digital signature collection built-in
✅ Automated review system for reputation management

🔒 Security & Compliance

HTTPS enforcement with SSL certificates
Secure credential storage in Google Secret Manager
Database encryption at rest and in transit
Role-based access control with SuiteCRM permissions
Input validation and SQL injection protection
Session management optimized for serverless

📊 Built-in Analytics

Real-time dashboards with key performance indicators
Revenue tracking and financial reporting
Technician performance metrics
Customer satisfaction tracking
Route optimization analytics
Custom reporting with SuiteCRM reports

🚀 Getting Started

Ready to deploy your own field service management system?

Read the deployment guide: DEPLOY_NOW.md
Get your API keys from Google Maps, Twilio, and SendGrid
Run the deployment script: ./deployment/cloud-run/quick-deploy.sh
Access your system at your Cloud Run URL

📄 License

This project is licensed under the MIT License - see the LICENSE.txt file for details.

🆘 Support

Issues: GitHub Issues
Discussions: GitHub Discussions
Documentation: See deployment/DEPLOYMENT_GUIDE.md

🎯 What You Get

✅ Complete field service management system ✅ Customer portal with online booking ✅ Real-time GPS tracking and dispatch ✅ Digital signatures and reviews ✅ Automated SMS and email notifications ✅ Payment processing with Stripe ✅ Production-ready deployment on Google Cloud ✅ Estimated cost: $50-400/month

🎊 Ready to compete with Housecall Pro? Deploy FaitCRM today!

Name		Name	Last commit message	Last commit date
Latest commit History 16,825 Commits
.github		.github
Api		Api
AsteriskSuiteCRM		AsteriskSuiteCRM
ModuleInstall		ModuleInstall
XTemplate		XTemplate
Zend		Zend
backend		backend
build		build
custom		custom
customer-portal		customer-portal
data		data
deployment		deployment
docker		docker
frontend		frontend
include		include
install		install
jssource		jssource
lib		lib
metadata		metadata
modules		modules
nextui-reference		nextui-reference
service		service
soap		soap
tests		tests
themes		themes
tools		tools
upload		upload
.codecov.yml		.codecov.yml
.env.dist		.env.dist
.gitattributes		.gitattributes
.gitignore		.gitignore
.php_cs.dist		.php_cs.dist
.travis.yml		.travis.yml
DEPLOY_NOW.md		DEPLOY_NOW.md
Dockerfile		Dockerfile
LICENSE.txt		LICENSE.txt
MODERNIZATION_SUMMARY.md		MODERNIZATION_SUMMARY.md
README.md		README.md
cloudbuild.yaml		cloudbuild.yaml
codacy.yml		codacy.yml
codeception.dist.yml		codeception.dist.yml
composer.json		composer.json
composer.json.backup.2025-07-31_12-37-09		composer.json.backup.2025-07-31_12-37-09
composer.lock		composer.lock
composer.lock.backup.2025-07-31_12-37-09		composer.lock.backup.2025-07-31_12-37-09
crossdomain.xml		crossdomain.xml
deploy.sh		deploy.sh
docker-compose.yml		docker-compose.yml
files.md5		files.md5
log_file_restricted.html		log_file_restricted.html
phpcs.xml		phpcs.xml
robots.txt		robots.txt
security_update_notes.json		security_update_notes.json
setup-proxy.sh		setup-proxy.sh
store-api-keys.sh		store-api-keys.sh
sugar_version.json		sugar_version.json
test_telephony.html		test_telephony.html
travis.php.ini		travis.php.ini

Uh oh!

License

Faitltd/faitCRM

Folders and files

Latest commit

History

Repository files navigation

🚀 FaitCRM - Advanced Field Service Management System

🏗️ Architecture

✨ Features

📅 Advanced Scheduling & Dispatch

📍 Real-time GPS Tracking

🌐 Customer Portal

📱 Mobile-Optimized Interface

💳 Payment Processing

📧 Automated Communications

🚀 Quick Start

Prerequisites

Production Deployment (Google Cloud Run)

Access Your System

Custom Domain Setup

📁 Project Structure

🔧 Configuration

Required API Keys

External Services Setup

💰 Cost Estimation

Monthly Operating Costs

🏆 Competitive Advantage

🔒 Security & Compliance

📊 Built-in Analytics

🚀 Getting Started

📄 License

🆘 Support

🎯 What You Get

About

Resources

License

Code of conduct

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases

Sponsor this project

Uh oh!

Packages 0

Contributors 200

Uh oh!

Languages

Packages