mirror of
https://github.com/shumaiOne/shumai.git
synced 2026-11-21 07:10:11 +00:00
27 lines
1.3 KiB
Plaintext
27 lines
1.3 KiB
Plaintext
---
|
|
title: Introduction
|
|
description: Welcome to Shumai, a modern AI agent and media processing platform.
|
|
---
|
|
|
|
## What is Shumai?
|
|
|
|
**Shumai** is a highly decoupled, modular platform built with a layered monorepo architecture. It integrates a React-based frontend, a fast Hono API backend, business logic services, and background workflow engines (supporting both local and Temporal-based execution).
|
|
|
|
### Key Features
|
|
|
|
- **Decoupled Monorepo Structure**: Managed via Bun Workspaces, ensuring each domain or layer is its own self-contained package.
|
|
- **Robust API & Core Service Layers**: Built on Bun and Hono, featuring strict end-to-end type safety with Zod schemas and DTOs.
|
|
- **Workflow & Activity Engine**: An orchestration engine capable of polling-based execution locally and enterprise-grade execution via Temporal.
|
|
- **Modern UI**: A responsive, clean React interface powered by Tailwind CSS and Shadcn UI.
|
|
- **Database Resilience**: Prisma ORM with PostgreSQL and `pgvector` for vector similarity and search capabilities.
|
|
|
|
## Explore the Documentation
|
|
|
|
Start by setting up Shumai on your local machine using our step-by-step guides.
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Get Started with Docker" icon="docker" href="/getting-started/docker">
|
|
Learn how to build and spin up the Shumai stack quickly using Docker Compose.
|
|
</Card>
|
|
</CardGroup>
|