Skip to content

BTheCoderr/EscapeRamp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

27 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Escape Ramp

A modern SaaS platform helping small businesses migrate from QuickBooks Desktop to cloud-based solutions.

πŸš€ Tech Stack

Next.js TypeScript Tailwind CSS Supabase Anthropic

πŸ“‹ Quick Links

β€’ Live Demo β€’ Frontend Repo β€’ Backend Repo


🎯 Overview

Escape Ramp is a comprehensive SaaS platform that helps small businesses migrate from QuickBooks Desktop to cloud-based solutions. Built with modern web technologies, it provides an intuitive interface for AI-powered migration assistance, document processing, and real-time progress tracking.

✨ Key Features

  • πŸ€– AI-Powered Intake Assistant - Conversational onboarding flow
  • πŸ“ Document Upload & Processing - Drag-and-drop file handling
  • πŸ“Š Historical Data Tracker - Complete audit trail and analytics
  • 🎧 Support Portal - Integrated help desk and live chat
  • πŸ“ˆ Real-time Dashboard - Migration progress and analytics
  • πŸ”’ Secure Authentication - Supabase Auth integration

πŸ—οΈ Architecture

This repository contains the original monorepo structure. For production use, we recommend using our split repositories:

πŸ› οΈ Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Supabase account
  • Anthropic API key

Installation

# Clone the repository
git clone https://github.com/BTheCoderr/escape-ramp.git
cd escape-ramp

# Install dependencies
npm install

# Set up environment variables
cp env.example .env.local
# Edit .env.local with your configuration

# Start development server
npm run dev

Open http://localhost:3000 to view the application.

πŸ”§ Environment Variables

Create a .env.local file with the following variables:

# Supabase Configuration
NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
SUPABASE_SERVICE_ROLE_KEY=your_supabase_service_role_key

# AI Services
ANTHROPIC_API_KEY=your_anthropic_api_key
OPENAI_API_KEY=your_openai_api_key

# QuickBooks Integration
QUICKBOOKS_CLIENT_ID=your_quickbooks_client_id
QUICKBOOKS_CLIENT_SECRET=your_quickbooks_client_secret
QUICKBOOKS_REDIRECT_URI=your_redirect_uri

# Email Service
RESEND_API_KEY=your_resend_api_key

# Payment Processing
STRIPE_SECRET_KEY=your_stripe_secret_key
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=your_stripe_publishable_key

πŸ“ Project Structure

escape-ramp/
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ app/                    # Next.js App Router
β”‚   β”‚   β”œβ”€β”€ api/               # API routes
β”‚   β”‚   β”‚   β”œβ”€β”€ intake/        # Intake form API
β”‚   β”‚   β”‚   β”œβ”€β”€ upload/        # File upload API
β”‚   β”‚   β”‚   β”œβ”€β”€ progress/      # Progress tracking API
β”‚   β”‚   β”‚   β”œβ”€β”€ transactions/  # Transaction CRUD
β”‚   β”‚   β”‚   β”œβ”€β”€ audit/         # Audit trail
β”‚   β”‚   β”‚   └── support/       # Support portal APIs
β”‚   β”‚   β”œβ”€β”€ layout.tsx         # Root layout
β”‚   β”‚   └── page.tsx           # Main page
β”‚   β”œβ”€β”€ components/            # React components
β”‚   β”‚   β”œβ”€β”€ Dashboard.tsx      # Main dashboard
β”‚   β”‚   β”œβ”€β”€ AIAssistant.tsx    # AI-powered intake
β”‚   β”‚   β”œβ”€β”€ DocumentUpload.tsx # File upload
β”‚   β”‚   β”œβ”€β”€ HistoricalDataTracker.tsx # Data tracking
β”‚   β”‚   β”œβ”€β”€ SupportPortal.tsx  # Support system
β”‚   β”‚   └── Navigation.tsx     # Sidebar navigation
β”‚   └── lib/                   # Utility libraries
β”‚       β”œβ”€β”€ types.ts           # TypeScript types
β”‚       β”œβ”€β”€ store.ts           # Zustand store
β”‚       β”œβ”€β”€ supabase.ts        # Supabase client
β”‚       β”œβ”€β”€ ai-service.ts      # AI service integration
β”‚       β”œβ”€β”€ quickbooks-parser.ts # QB data parsing
β”‚       └── utils.ts           # Utility functions
β”œβ”€β”€ python-service/            # Python microservices
β”‚   β”œβ”€β”€ invoice_parser.py      # Invoice parsing service
β”‚   β”œβ”€β”€ requirements.txt       # Python dependencies
β”‚   └── README.md              # Python service docs
β”œβ”€β”€ demo-data/                 # Sample QuickBooks data
β”œβ”€β”€ *.sql                      # Database schemas
└── README.md

πŸ§ͺ Development

Available Scripts

npm run dev          # Start development server
npm run build        # Build for production
npm run start        # Start production server
npm run lint         # Run ESLint
npm run type-check   # Run TypeScript check

Python Service Development

cd python-service
pip install -r requirements.txt
uvicorn invoice_parser:app --reload --port 8000

πŸ“š API Endpoints

Intake Processing

  • POST /api/intake - Process intake forms
  • GET /api/intake - Retrieve intake data

File Upload

  • POST /api/upload - Upload and process files
  • GET /api/upload - Retrieve file metadata

Migration Progress

  • GET /api/progress - Get migration status
  • PUT /api/progress - Update progress

Transactions

  • GET /api/transactions - List transactions
  • POST /api/transactions - Create transaction
  • PUT /api/transactions/:id - Update transaction
  • DELETE /api/transactions/:id - Delete transaction

Support Portal

  • GET /api/support/tickets - List support tickets
  • POST /api/support/tickets - Create ticket
  • PUT /api/support/tickets/:id - Update ticket
  • GET /api/support/messages - Get messages
  • POST /api/support/messages - Send message

Python Service

  • POST /parse-invoice - Parse invoice with AI
  • POST /parse-document - Parse any document
  • GET /health - Health check

πŸ—„οΈ Database Schema

Core Tables

  • intake_form - User intake data
  • migration_status - Migration progress
  • documents - File metadata
  • parsed_invoices - Extracted invoice data

Historical Data

  • transactions - Financial transactions
  • transaction_changes - Change tracking
  • audit_events - System audit trail
  • data_snapshots - Data versioning

Support System

  • support_tickets - Help tickets
  • support_messages - Ticket messages
  • support_attachments - File attachments
  • support_knowledge_base - Help articles

πŸ€– AI Integration

Anthropic Claude

  • Intake form analysis
  • Migration planning
  • Customer support

OpenAI GPT-4

  • Invoice parsing
  • Document processing
  • Data validation

QuickBooks Parser

  • CSV/IIF file parsing
  • Data validation
  • Migration mapping

πŸš€ Deployment

Vercel (Recommended)

  1. Connect your GitHub repository to Vercel
  2. Configure environment variables
  3. Deploy automatically on push to main

Netlify

  1. Import your GitHub repository
  2. Set build command: npm run build
  3. Set publish directory: .next

Python Service (Railway/Render)

cd python-service
railway login
railway init
railway up

πŸ”’ Security

Authentication

  • Supabase Auth integration
  • JWT token validation
  • Role-based access control

Data Protection

  • Row Level Security (RLS)
  • Encrypted data storage
  • Secure file uploads

API Security

  • Rate limiting
  • Input validation
  • CORS configuration

πŸ› Troubleshooting

Common Issues

  1. Build Errors

    # Clear cache and reinstall
    rm -rf node_modules .next
    npm install
    npm run build
  2. Environment Variables

    • Ensure all required variables are set
    • Check for typos in variable names
    • Restart development server after changes
  3. Supabase Connection

    • Verify URL and keys are correct
    • Check network connectivity
    • Review Supabase dashboard for errors

πŸ“„ License

This project is proprietary software. All rights reserved.

🀝 Contributing

See CONTRIBUTING.md for contribution guidelines.

πŸ‘₯ Team

  • Baheem - Project Lead & Full Stack
  • Dante - Frontend UI/UX
  • Thomas - Backend API/Database
  • Pio - DevOps & Infrastructure
  • Sean - AI/ML Integration
  • Adrian - Testing & Quality Assurance

Built with ❀️ by the Escape Ramp Team

About

πŸš€ Escape Ramp: Complete QuickBooks Migration Solution - Modern SaaS tool helping businesses migrate from QuickBooks Desktop to cloud alternatives with AI-powered guidance, transparent pricing, and advanced analytics.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors