Skip to content

Update README.md - #53

Open
xiaunknown116-del wants to merge 1 commit into
cloudflare:mainfrom
xiaunknown116-del:patch-1
Open

Update README.md#53
xiaunknown116-del wants to merge 1 commit into
cloudflare:mainfrom
xiaunknown116-del:patch-1

Conversation

@xiaunknown116-del

Copy link
Copy Markdown

Project Description
Apex Platform Engine (lucky-river-ad40) is a multi-tenant serverless runtime platform built on Cloudflare Workers. It provides an enterprise-grade execution environment that isolates administrative operations, serves static frontend assets, and executes dynamic customer workloads.
Key Architectural Components

  • Edge Gateway (src/index.ts): Acts as the central entry point.
    • Administrative Operations (/admin): Restricted area requiring an X-Identity-Token header for access. Rejects requests from internal CGNAT/Tailscale IP ranges (100.64.x.x and 100.127.x.x). Contains the /admin/api/deploy endpoint for deploying script modules to customer sandboxes via the Cloudflare API.
    • Dynamic Workspaces (/app/:tenantId): Routes traffic to tenant sandboxes via Cloudflare Workers for Platforms (CUSTOMER_COMPUTE dispatch namespace), resolving script bindings via key-value lookup (AUTH_KV).
    • Public Marketing Frontend: Automatically offloads static site requests to assets located in the ./website directory via Cloudflare Workers Static Assets (ASSETS binding).
  • Egress Security Guard (src/outbound.ts): Filters egress traffic by blocking calls to internal domains (*.internal, localhost) and stripping platform headers (X-Identity-Token) prior to external dispatch.
  • Testing Engine (src/index.test.ts): Vitest isolation engine tests validating edge security rules, drop behaviors for unauthenticated admin calls, and IP spoofing prevention.
  • Automated CI/CD (.github/workflows/deploy.yml): GitHub Actions workflow that executes TypeScript typechecks (tsc --noEmit), runs Vitest test suites, and deploys directly to Cloudflare via cloudflare/wrangler-action@v3.
    Pull Request & Git Deployment Strategy
    To merge, test, and deploy these platform updates into your GitHub repository, execute the following commands:
  1. Commit Local Blueprint & Apply Configuration

Initialize local repository if not already established

git init

Stage all updated file paths

git add .
git commit -m "feat: complete apex platform engine edge compute architecture"

  1. Branch Cleanup & PR Deployment Workflow

Switch to main branch

git branch -M main

Link remote GitHub repository

git remote add origin https://github.com/YOUR_ORGANIZATION/apex-platform-engine.git

Clean up stale temporary branches (e.g., xiaunknown116-del) locally and remotely

git branch -D xiaunknown116-del 2>/dev/null
git push origin --delete xiaunknown116-del 2>/dev/null

Push updates to main to trigger GitHub Action CI/CD deployment

git push -u origin main

  1. Continuous Integration Matrix Verification
    Upon pushing to main, GitHub Actions will execute .github/workflows/deploy.yml:
  • Typechecking: npx tsc --noEmit verifies strict TypeScript types.
  • Unit Tests: npm run test executes src/index.test.ts to confirm security gates.
  • Cloudflare Deployment: cloudflare/wrangler-action@v3 publishes lucky-river-ad40 live using CLOUDFLARE_API_TOKEN and CLOUDFLARE_ACCOUNT_ID.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant