Welcome to Surkyl Platform Documentation

Comprehensive documentation for building modern applications on the Surkyl Platform

Get Started View on GitHub

Explore the Platform

Getting Started

New to Surkyl? Start here to learn the basics and get your development environment set up.

Quick Start Guide →

Applications

Explore production-ready applications including Gate API Gateway, Surkyl Server, and more.

Browse Apps →

Libraries

Discover reusable libraries like Pixel Component Library and the powerful Workflow Engine.

Explore Libraries →

Contributing

Learn how to contribute to the platform with our comprehensive guide.

Contributing Guide →

Featured Documentation

Gate API Gateway

High-performance API gateway written in Rust with Axum framework.

Features: Virtual hosts, load balancing, TLS, health checks

Learn more →

Surkyl Server

Core backend server with authentication, RBAC, and Guardian access control.

Tech Stack: Rust + Axum + SQLx + PostgreSQL

Learn more →

Pixel Library

Modern Angular component library with Material Design and TailwindCSS.

Includes: Theme system, UI components, Workflow Engine

Learn more →

Workflow Engine

Powerful YAML-based workflow automation system (NanX Flows).

Supports: Custom nodes, distributed processing, Python workers

Developer Guide →

Technology Stack

The Surkyl Platform is built with modern, production-ready technologies:

Backend: Rust (Axum framework), PostgreSQL, SQLx
Frontend: Angular 20+, Astro, TailwindCSS
Infrastructure: Docker, Nx monorepo, PostgreSQL, Redis
Testing: Vitest, Playwright, Cargo test

Quick Links

Monorepo Structure

Understanding the organization of the AIO monorepo and how projects are structured.

Learn about the structure →

PostHog Integration

Integrate analytics with PostHog using the GodSEye Proxy to bypass ad blockers.

Integration Guide →

RBAC System

Comprehensive role-based access control with fine-grained permissions.

RBAC Documentation →

Theme System

Comprehensive TailwindCSS theme system with dark mode support.

Theme Guide →

What’s Next?

Install Dependencies

pnpm install

Run an Application

nx serve playground
nx serve docs

Build for Production

nx build <project-name>

View Dependency Graph

nx graph

surkyl.com • Documentation • GitHub