> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/stormkit-io/stormkit-io/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome to Stormkit

> Self-hostable deployment platform for modern web applications with automated CI/CD, custom domains, and comprehensive environment management.

# Welcome to Stormkit

Stormkit is a powerful, self-hostable alternative to Vercel and Netlify for deploying modern web applications. Built with a Go backend and React frontend, it provides seamless deployment and management of frontend applications with automated CI/CD, custom domains, and advanced features like serverless functions, database migrations, and analytics.

## Choose Your Edition

<CardGroup cols={2}>
  <Card title="Cloud Edition" icon="cloud" href="https://app.stormkit.io">
    Managed solution with automatic scaling, maintenance, and hosting handled for you. Focus on building while we handle the infrastructure.
  </Card>

  <Card title="Self-Hosted Edition" icon="server" href="/docs/self-hosting/getting-started">
    Complete control over your deployment infrastructure. Perfect for organizations with specific compliance requirements or custom infrastructure needs.
  </Card>
</CardGroup>

## Key Features

<CardGroup cols={2}>
  <Card title="Git-Based Deployments" icon="code-branch">
    Seamless integration with GitHub, GitLab, and Bitbucket. Deploy with every push using automated CI/CD pipelines.
  </Card>

  <Card title="Multiple Environments" icon="layer-group">
    Create unlimited environments per application. Each environment can point to a different branch with isolated configurations and deployments.
  </Card>

  <Card title="Serverless Functions" icon="function">
    Write Node.js/TypeScript APIs with filesystem-based routing. Functions deploy to AWS Lambda with 15-second timeouts.
  </Card>

  <Card title="Database Integration" icon="database">
    PostgreSQL schemas with automatic migrations, isolated credentials, and secure environment variable injection for each environment.
  </Card>

  <Card title="Custom Domains & SSL" icon="globe">
    Configure custom domains with automatic TLS certificate provisioning. Support for custom certificates and headers.
  </Card>

  <Card title="Privacy-First Analytics" icon="chart-line">
    Server-side analytics with no client cookies. Track visitors, referrers, and top paths while respecting user privacy.
  </Card>

  <Card title="Image Optimization" icon="image">
    On-the-fly image resizing and smart cropping via URL parameters. Automatic caching for improved performance.
  </Card>

  <Card title="Teams & Permissions" icon="users">
    Collaborate with role-based access control. Owner, Admin, and Developer roles with granular permissions.
  </Card>
</CardGroup>

## What You Can Deploy

Stormkit supports all modern frontend frameworks and static site generators:

* **React** - Next.js, Create React App, Vite, Remix
* **Vue** - Nuxt.js, Vite, Vue CLI
* **Angular** - Angular CLI applications
* **Static Sites** - Gatsby, Docusaurus, Hugo, Jekyll
* **And more** - Any framework that outputs static files or Node.js serverless functions

## How Stormkit Works

<Steps>
  <Step title="Connect Your Repository">
    Authenticate with GitHub, GitLab, or Bitbucket and select your repository. Stormkit integrates directly with your git flow.
  </Step>

  <Step title="Configure Environments">
    Set up your build commands, output folders, and environment variables. Create separate environments for production, staging, and development.
  </Step>

  <Step title="Deploy Automatically">
    Push to your repository and Stormkit automatically builds, deploys, and leaves preview links on pull requests. Enable auto-publish for production branches.
  </Step>

  <Step title="Manage & Monitor">
    View deployment logs, monitor analytics, manage custom domains, and collaborate with your team—all from the dashboard.
  </Step>
</Steps>

## Deployment Architecture

Stormkit leverages AWS infrastructure for reliable, scalable deployments:

* **Static Assets** - Served from S3 buckets through CloudFront CDN
* **Server-Side Rendering** - Deployed to AWS Lambda functions
* **API Routes** - File-system routed serverless functions
* **Database** - PostgreSQL with isolated schemas per environment
* **Image Optimization** - On-demand processing with intelligent caching

## Get Started

<CardGroup cols={2}>
  <Card title="Quickstart Guide" icon="rocket" href="/quickstart">
    Get from account setup to your first deployment in minutes. Follow our step-by-step guide.
  </Card>

  <Card title="Self-Hosting Setup" icon="download" href="/docs/self-hosting/getting-started">
    Host Stormkit on your own infrastructure using Docker containers or binaries.
  </Card>

  <Card title="Deploy Your First App" icon="play" href="/docs/deployments/introduction">
    Learn about deployment triggers, build configuration, and environment settings.
  </Card>

  <Card title="Explore Features" icon="star" href="/docs/features/analytics">
    Discover advanced features like analytics, databases, teams, and serverless APIs.
  </Card>
</CardGroup>

## Microservices Architecture

Stormkit consists of these core services:

* **API Server** (`src/ce/api/`) - REST API for application management
* **Hosting Service** (`src/ce/hosting/`) - Serves deployments and static assets
* **Runner** (`src/ce/runner/`) - Executes builds and deployments
* **Worker Server** (`src/ce/workerserver/`) - Background job processing

<Note>
  Stormkit requires PostgreSQL 14+ and Redis 7+ to function. These services handle data persistence and caching.
</Note>

## Community & Support

<CardGroup cols={3}>
  <Card title="GitHub" icon="github" href="https://github.com/stormkit-io/stormkit-io">
    View source code, report issues, and contribute to the project.
  </Card>

  <Card title="Documentation" icon="book" href="/docs/welcome/getting-started">
    Comprehensive guides for all Stormkit features and APIs.
  </Card>

  <Card title="Contact Us" icon="envelope" href="/docs/welcome/contact-us">
    Get help from the Stormkit team and community.
  </Card>
</CardGroup>

## License

* **Community Edition** (`src/ce/`) - Open source under AGPL-3.0
* **Enterprise Edition** (`src/ee/`) - Commercial features requiring a license

Ready to deploy? Start with our [Quickstart Guide](/quickstart) or explore the [Features](/features/analytics) to see what Stormkit can do.