Documentation

OrbitAI Solutions Documentation

Technical manuals, user guides, and deployment instructions for the OrbitAI Solutions automation platform.

Technical Manual

Default content · not yet saved

OrbitAI Solutions — Technical Manual

1. Overview

OrbitAI Solutions is an automation-agency business platform built as a single-page React application on the Base44 backend-as-a-service platform. It combines project delivery, client onboarding, financial reporting, an education hub (Orbit Academy), affiliate management, and AI-assisted tooling.

2. Technology Stack

| Layer | Technology | |---|---| | Framework | React 18 (SPA) | | Build tool | Vite | | Styling | Tailwind CSS + shadcn/ui | | Icons | lucide-react | | Routing | react-router-dom | | Data fetching / cache | @tanstack/react-query | | Animation | framer-motion | | Charts | recharts | | Drag & drop | @hello-pangea/dnd | | Maps | react-leaflet | | 3D | three.js | | PDF generation | jspdf | | Spreadsheet I/O | xlsx | | Rich text | react-quill | | Markdown render | react-markdown | | Dates | date-fns | | Backend / Auth / DB | Base44 BaaS + SDK |

3. Application Router

src/App.jsx defines all routes. Public routes: /login, /register, /forgot-password, /reset-password, /about, /contact. Authenticated routes are wrapped in <ProtectedRoute> and <OnboardingGuard>, with the internal app shell rendered by <AppLayout> (sidebar + outlet).

4. Entity Data Model

Core Delivery

  • WorkflowProject — Project records with status (draft/proposed/active/completed), stages, financials, due dates.
  • ClientOnboarding — Per-client 6-step checklist (contract → deposit → intake → kickoff scheduled → access → kickoff completed).
  • ClientFeedback — Star ratings + notes submitted by clients.
  • ProjectActivity — Audit log of status changes, cost updates, comments, file uploads.
  • TimeEntry — Logged hours per project/team member (billable flag).
  • Invoice — Invoices with lifecycle (draft → sent → viewed → paid → overdue).
  • ProjectCalendarEvent — Links a project to a synced Google Calendar event.

Knowledge & Resources

  • ResourceLibrary — Uploaded files / external asset links, optionally client-visible.
  • DocumentationGuide — Stores these editable documentation pages.
  • ImportAudit — Audit trail for bulk CSV/Excel imports.
  • ToolAccessRequest — Access requests for platform tools (admin-managed).
  • AppSettings — Key-value store for app configuration.
  • SecurityEvent — Logged security events for monitoring.

Orbit Academy

  • AcademyCourse — Course catalog (category, cost tier, skill level, affiliate link).
  • AcademyEnrollment — Per-user enrollment + progress.
  • AcademyCertificate — Issued completion certificates with verification codes.
  • AcademyLeaderboard — Aggregated completion stats per learner.
  • AcademyCourseReview — Course ratings and comments.
  • AcademyReferral — Per-user referral codes.
  • AcademyReferralEvent — Click / signup attribution events.

Affiliate

  • AffiliateLink — Managed affiliate partnerships.
  • AffiliateClick — Click tracking and commission data.

Built-in

  • User — Built-in auth user (id, email, full_name, role). Records are created via invites, not direct inserts.

5. Row-Level Security (RLS)

Most entities restrict create/update/delete to the admin role. Academy learner-facing entities (enrollments, certificates, reviews, referrals) allow self-service create/update for the owning user via data.user_id = {{user.id}} rules, with admin bypass. Client-facing entities (ClientFeedback) allow any authenticated user to create, and read their own records.

6. Backend Functions

| Function | Purpose | |---|---| | syncProjectToCalendar | Sync project due dates to Google Calendar | | syncKickoffToCalendar | Create kickoff-call calendar events | | sendSlackAlert | Post project status alerts to Slack | | sendFeedbackRequest | Email feedback survey on project completion | | sendInvoiceEmail | Email invoice to client | | sendOverdueReminders | Daily check for overdue invoices | | sendWeeklyClientReports | Monday client progress emails | | sendMonthlyClientReports | Monthly client summary emails | | notifyProjectCompleted | Slack notification on project completion | | notifyToolAccessRequest | Slack alert on new tool access request | | checkTeamCapacityAlerts | Team capacity threshold alerts | | bulkImportData | Bulk import projects/clients from file |

Note: Backend functions require a Builder+ subscription to create or modify.

7. AI Agents

  • docs_assistant — Answers stakeholder questions from DocumentationGuide content.
  • onboarding_assistant — Tracks ClientOnboarding task progression.
  • workflow_advisor — Recommends automation workflow stages.

8. Automations

  • Entity automation on WorkflowProject create/update/delete → Google Calendar sync.
  • Scheduled automation (daily) → overdue invoice reminders.
  • Entity automation on WorkflowProject update (status = completed) → feedback request.

9. Integrations

  • Google Calendar — OAuth shared connector for milestone/kickoff event sync.
  • Slack — Workspace connector for project alerts and notifications.

10. Key Pages

| Page | Route | Purpose | |---|---|---| | Overview | / | Business KPIs, pipeline, forecasts | | Project Kanban | /project-kanban | Drag projects through status stages | | Project Roadmap | /project-roadmap | Timeline + onboarding board per project | | Client Onboarding | /client-onboarding | List + Kanban board of onboarding stages | | Client Portal | /client-portal | All client projects + PDF/email exports | | Academy | /academy | Course catalog, enrollments, leaderboard | | Documentation Hub | /docs | This hub — edit + download (PDF/Word) |

11. Client-Side Export Strategy

To avoid backend dependencies, all report exports are browser-based: jspdf for PDF and Word-compatible HTML blobs for .doc downloads. CSV exports use a shared src/lib/exportCSV.js utility.