Skip to content
Surkyl Docs

Introduction to Surkyl Platform

Welcome to Surkyl Platform

Section titled “Welcome to Surkyl Platform”

Surkyl Platform is a comprehensive monorepo containing applications, libraries, and tools for building modern, scalable web applications. Built with modern technologies including Rust, Angular, Astro, and more.

What is Surkyl?

Section titled “What is Surkyl?”

Surkyl is an integrated platform consisting of:

  • Applications: Production-ready applications including API gateways, backend servers, and web applications
  • Libraries: Reusable component libraries and utilities
  • Plugins: Custom Nx plugins for extended functionality
  • Infrastructure: Docker configurations, CI/CD pipelines, and deployment tools

Key Components

Section titled “Key Components”

Applications

Section titled “Applications”
  • Gate: High-performance API gateway written in Rust
  • Surkyl Server: Backend server with authentication, RBAC, and database management
  • GodSEye Proxy: PostHog reverse proxy for analytics without ad-blocker interference
  • MueSync: Landing page and marketing website
  • Identity UI: User authentication and identity management interface

Libraries

Section titled “Libraries”
  • Pixel: Modern Angular component library with Material Design
  • Workflow Engine (NanX Flows): Powerful YAML-based workflow automation system
  • Surkyl Core: Shared Rust utilities and core functionality
  • Hypers: HTTP utilities and helpers
  • VISC: Validation and utility library

Plugins

Section titled “Plugins”
  • nx-astro: Nx plugin for Astro/Starlight projects
  • nx-sveltekit: Nx plugin for SvelteKit applications

Technology Stack

Section titled “Technology Stack”
  • Frontend: Angular 20+, Astro, TailwindCSS
  • Backend: Rust (Axum framework), Node.js
  • Database: PostgreSQL with SQLx
  • Infrastructure: Docker, Nx monorepo
  • Testing: Vitest, Playwright

Who Is This For?

Section titled “Who Is This For?”

This documentation is designed for:

  • Developers building applications on the Surkyl platform
  • Contributors wanting to understand the architecture and contribute to the project
  • DevOps Engineers deploying and managing Surkyl services
  • Product Teams understanding capabilities and integration points

Getting Help

Section titled “Getting Help”
  • Check the relevant section in this documentation
  • Review the API reference for technical details
  • See the contributing guide for development workflows

Next Steps

Section titled “Next Steps”