KFSQUARE - Data Analytics & Predictive Modeling

Overview

KFSQUARE is a data engineering and analytics company leveraging cutting-edge Large Language Models (LLM) to deliver predictive analysis and transformative insights for businesses. This modern, responsive, platform-agnostic website showcases our services and provides an interactive platform for client engagement across Windows, macOS, and Linux systems.

🌐 Cross-Platform Support

Supported Platforms

• ✅ Windows (10/11, Server 2016/2019/2022)
• ✅ macOS (Intel & Apple Silicon)
• ✅ Linux (Ubuntu, CentOS, RHEL, Fedora, Arch, openSUSE)
• ✅ Docker (Multi-architecture: AMD64, ARM64)
• ✅ Cloud Platforms (AWS, Azure, GCP, Heroku, Vercel)

Browser Compatibility

• ✅ Modern Browsers: Chrome, Firefox, Safari, Edge (latest)
• ✅ Legacy Support: Internet Explorer 8+ (graceful degradation)
• ✅ Mobile: iOS Safari, Android Chrome (responsive design)

🚀 Quick Start (Any Platform)

Prerequisites

• Node.js 18+: Download here
• Python 3.7+: Download here (for fallback server)
• Git: Download here

Automated Setup (Recommended)

# Clone repository
git clone <your-repo-url>
cd kfsquare

# Option 1: Cross-platform shell script
./setup-cross-platform.sh      # Linux/macOS
bash setup-cross-platform.sh   # Windows Git Bash/WSL

# Option 2: Python setup utility (any platform)
python setup.py --setup        # Full automated setup
python3 setup.py --setup       # Linux/macOS alternative

Manual Setup

# 1. Install Node.js 18+ from https://nodejs.org
# 2. Clone and setup
git clone <your-repo-url>
cd kfsquare

# 3. Install Python requirements (optional, for utilities)
pip install -r requirements-minimal.txt
# OR for full development environment
pip install -r requirements.txt

# 4. Install Node.js dependencies
npm install

# 5. Configure environment
cp .env.example .env
# Configure Mailgun in .env (see below)

# 6. Start development
npm run dev
# OR fallback Python server
python -m http.server 8080

📦 Platform-Specific Scripts

Windows

# Command Prompt
npm run dev
start-production.bat

# PowerShell
npm run dev
.\start-production.bat

# Git Bash (Recommended)
npm run dev
./start-production.sh

macOS/Linux

npm run dev
./start-production.sh

Cross-Platform Commands

# Setup and deployment
npm run setup     # Run setup script
npm run deploy    # Run deployment script
python setup.py --setup    # Python setup utility
python setup.py --health   # Check server health

# Development servers
npm run dev       # Node.js development server
npm run serve     # Python fallback server (any platform)
npm run serve:win # Python server (Windows specific)

# Utilities
npm run health    # Check server health
python setup.py --start    # Start development server (any platform)

📦 Dependencies

Node.js Dependencies (Required)

{
  "express": "^5.1.0",
  "helmet": "^8.0.0",
  "compression": "^1.7.4",
  "express-rate-limit": "^7.4.1",
  "mailgun.js": "^10.2.3",
  "form-data": "^4.0.0",
  "cross-env": "^7.0.3"
}

Python Dependencies (Optional)

# Install minimal requirements
pip install -r requirements-minimal.txt

# OR install full development environment
pip install -r requirements.txt

Minimal Python Requirements:

• requests>=2.31.0 - HTTP requests and health checks
• python-dotenv>=1.0.0 - Environment variable management
• colorama>=0.4.6 - Cross-platform colored output

Full Python Requirements: (for development)

• Testing: pytest, black, flake8, mypy
• Documentation: mkdocs, mkdocs-material
• Security: bandit, safety
• Monitoring: psutil, watchdog

⚙️ Environment Configuration

Create a .env file with the following variables:

# Server Configuration
NODE_ENV=production
PORT=3000

# Mailgun Email Configuration
MAILGUN_API_KEY=your_mailgun_api_key_here
MAILGUN_DOMAIN=mg.kfsquare.com
# MAILGUN_BASE_URL=https://api.mailgun.net   # or https://api.eu.mailgun.net for EU
RECIPIENT_EMAIL=customersupport@kfsquare.com

# Security Configuration
GENERAL_RATE_LIMIT=100
EMAIL_RATE_LIMIT=5
ALLOWED_ORIGINS=https://kfsquare.com,https://www.kfsquare.com

🔧 Available Scripts

• npm start: Start production server
• npm run dev: Start development server
• npm run build: Prepare for production (no build needed)
• npm test: Run tests (not implemented)
• ./deploy.sh: Full production deployment preparation

📊 API Endpoints

Health Check

GET /health

Returns server status and uptime information.

Contact Form

POST /send-email

Accepts contact form submissions with validation and rate limiting.

Request Body:

{
  "name": "Your Name",
  "email": "your.email@example.com",
  "message": "Your message here"
}

🛡️ Security Features

• Content Security Policy (CSP)
• HTTP Strict Transport Security (HSTS)
• X-Frame-Options protection
• Input validation and sanitization
• Rate limiting (100 requests/15min general, 5 emails/hour)
• CORS protection
• Error handling without information leakage

🌐 Browser Support

• Modern Browsers: Chrome, Firefox, Safari, Edge (latest versions)
• Legacy Support: Internet Explorer 8+ (with graceful degradation)
• Mobile: iOS Safari, Android Chrome (responsive design)

📱 Responsive Design

• Mobile First: Optimized for mobile devices
• Tablet: Enhanced experience for tablet users
• Desktop: Full-featured desktop experience
• High DPI: Retina and high-resolution display support

🚀 Production Checklist

• ✅ Environment variables configured
• ✅ Dependencies installed
• ✅ Security headers enabled
• ✅ Rate limiting configured
• ✅ SSL/HTTPS ready
• ✅ Static file caching
• ✅ Error handling
• ✅ Health check endpoint
• ✅ Graceful shutdown
• ✅ Production logging

📞 Support

For technical support or questions:

• Email: contact@kfsquare.com
• Website: https://kfsquare.com
• Chat: Available on the website

📄 License

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

---

KFSQUARE - Transforming Data into Insights 🚀 ```

4. Run the server:

   node server.js

5. Open index.html in your browser. It's recommended to use a development server (e.g., serve) to avoid CORS issues.

Key Files

• index.html: The main HTML file containing the website structure and content.
• styles.css: CSS file for styling the website.
• script.js: JavaScript file for handling form submission and client-side logic.
• server.js: Node.js server file for handling form submissions and sending emails via Mailgun.
• .env: File for storing sensitive information like API keys and email addresses.

Email Configuration (Mailgun)

Set these in your .env:

MAILGUN_API_KEY=your_mailgun_api_key_here
MAILGUN_DOMAIN=mg.kfsquare.com
# MAILGUN_BASE_URL=https://api.mailgun.net   # or https://api.eu.mailgun.net for EU
RECIPIENT_EMAIL=customersupport@kfsquare.com

The website includes a contact form that sends emails using Mailgun. The server-side code handles the email sending process via Mailgun SDK.

Important:

• Make sure you have a Mailgun account and have created an API key with the necessary permissions.
• Verify the "no-reply" email address with Mailgun to prevent emails from being marked as spam.

CORS Configuration

The server uses CORS to allow requests from the frontend. Make sure the CORS_ORIGIN environment variable is set to the correct URL of your frontend.

Input Validation

The server uses express-validator to validate the form data on the server-side.

Error Handling

The server includes error handling and logging to help identify and resolve issues.

Production Deployment

When deploying to production:

• Set the environment variables directly in your hosting environment.
• Ensure that the CORS origin is set to the correct URL of your production frontend.
• Consider using a process manager like PM2 to keep the server running.

Contributing

Contributions are welcome! Please submit a pull request with your changes.

License

© 2025 KFSQUARE. All rights reserved.