Applications Overview
Applications Overview
Section titled “Applications Overview”The Surkyl Platform includes several production-ready applications, each serving a specific purpose in the ecosystem. This page provides an overview of all available applications.
Backend Services
Section titled “Backend Services”Gate - API Gateway
Section titled “Gate - API Gateway”High-performance API gateway written in Rust with the Axum framework. Provides routing, load balancing, TLS termination, and more.
- Technology: Rust + Axum
- Purpose: API Gateway and reverse proxy
- Key Features: Virtual hosts, load balancing, static file serving, health checks
- Learn more about Gate →
Surkyl Server
Section titled “Surkyl Server”Main backend server providing authentication, RBAC (Role-Based Access Control), and core platform functionality.
- Technology: Rust + Axum + SQLx + PostgreSQL
- Purpose: Core backend services
- Key Features: JWT authentication, RBAC, database management, Guardian access control
- Learn more about Surkyl Server →
GodSEye Proxy
Section titled “GodSEye Proxy”PostHog reverse proxy designed to bypass ad blockers and provide reliable analytics.
- Technology: Rust
- Purpose: Analytics proxy
- Key Features: PostHog integration, ad-blocker bypass, request forwarding
- Learn more about GodSEye Proxy →
Workflow execution service for running automated workflows and background jobs.
- Technology: Rust
- Purpose: Workflow execution
- Key Features: YAML workflows, job queuing, distributed processing
- [Documentation coming soon]
Frontend Applications
Section titled “Frontend Applications”Playground
Section titled “Playground”Development playground and demo application showcasing the Pixel component library and platform capabilities.
- Technology: Angular 20+ (standalone components)
- Purpose: Development and demos
- Key Features: Component showcase, feature demos, development sandbox
- Command:
nx serve playground
Identity UI
Section titled “Identity UI”User authentication and identity management interface providing login, registration, and profile management.
- Technology: Angular 20+ (standalone components)
- Purpose: User authentication UI
- Key Features: Login/register forms, profile management, session handling
- Command:
nx serve identity-ui
Websites
Section titled “Websites”Documentation Site (This Site)
Section titled “Documentation Site (This Site)”Comprehensive documentation for the Surkyl Platform built with Astro and Starlight.
- Technology: Astro + Starlight
- Purpose: Platform documentation
- Key Features: Search, responsive design, syntax highlighting
- Command:
nx serve docs
MueSync Landing Page
Section titled “MueSync Landing Page”Marketing and landing page for the MueSync product.
- Technology: Astro + TailwindCSS
- Purpose: Product marketing
- Key Features: PostHog analytics, responsive design, countdown timers
- Command:
nx serve muesync-com - Learn more about MueSync →
Surkyl Company Website
Section titled “Surkyl Company Website”Company website showcasing the Surkyl platform and products.
- Technology: Astro + TailwindCSS
- Purpose: Company marketing
- Key Features: PostHog analytics, responsive design, product showcase
- Command:
nx serve surkyl-com - Learn more about Surkyl Website →
Application Types
Section titled “Application Types”Services (Backend)
Section titled “Services (Backend)”Backend services are typically long-running processes that:
- Run as Docker containers in production
- Provide APIs and core functionality
- Handle data storage and processing
- Scale horizontally
Applications (Frontend)
Section titled “Applications (Frontend)”Frontend applications are:
- Built as static sites or SPAs
- Served via CDN or web server
- Interact with backend services via APIs
- Optimized for user experience
Websites
Section titled “Websites”Marketing and documentation sites:
- Static site generation (SSG)
- Fast loading and SEO-optimized
- Content-focused
- Easy to deploy and maintain
Technology Stack
Section titled “Technology Stack”| Application | Language | Framework | Database | Deployment |
|---|---|---|---|---|
| Gate | Rust | Axum | - | Docker |
| Surkyl Server | Rust | Axum | PostgreSQL | Docker |
| GodSEye Proxy | Rust | - | - | Docker |
| NanX | Rust | - | Redis | Docker |
| Playground | TypeScript | Angular 20+ | - | Static/CDN |
| Identity UI | TypeScript | Angular 20+ | - | Static/CDN |
| Docs | TypeScript | Astro | - | Static/CDN |
| MueSync | TypeScript | Astro | - | Static/CDN |
| Surkyl.com | TypeScript | Astro | - | Static/CDN |
Quick Start
Section titled “Quick Start”Run a Backend Service
Section titled “Run a Backend Service”# Build and run with Nxnx build gatenx serve gate
# Or use Dockercd apps/gatedocker-compose upRun a Frontend App
Section titled “Run a Frontend App”# Development servernx serve playground
# Production buildnx build playgroundRun a Website
Section titled “Run a Website”# Development server with hot reloadnx serve docs
# Production buildnx build muesync-comNext Steps
Section titled “Next Steps”- Explore individual application documentation
- Learn about Libraries used by these apps
- Check the Quick Start Guide for setup instructions
- Review the Contributing Guide to start contributing