菜单
Serverpod overview — what it is, project structure, installation, creating and running a project. Use when the user asks about Serverpod in general, project setup, installation, serverpod create, or running a Serverpod server.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Add Serverpod authentication — serverpod_auth_idp packages, initializeAuthServices, identity providers (Email, Google, Apple, etc.), Flutter sign-in UI, migrations. Use when adding authentication or a new social sign-in to a Serverpod project.
Serverpod caching — local and Redis caches, cache keys, lifetime, CacheMissHandler. Use when caching data, optimizing queries, or working with session.caches.
Serverpod CLI — serverpod create, generate, create-migration, and other commands. Use when generating code, creating migrations, or creating projects/modules.
Configure Serverpod — YAML config, environment variables, passwords, run modes, generator.yaml, TLS. Use when setting up environments, API/database/Redis settings, or managing secrets.
Serverpod ORM with PostgreSQL — CRUD, filters, sorting, pagination, relations, migrations, transactions, raw SQL. Use when querying the database, writing migrations, or working with relations. Also include serverpod-models skill if you need to change models.
Define Serverpod endpoints, use Session, pass parameters, and call from client. Use when creating RPC endpoints, working with Session, or client code generation.
| name | serverpod-overview |
| description | Serverpod overview — what it is, project structure, installation, creating and running a project. Use when the user asks about Serverpod in general, project setup, installation, serverpod create, or running a Serverpod server. |
Serverpod is an open-source backend framework for Flutter written in Dart. A Serverpod project consists of three packages: a server, a generated client, and a Flutter app. The server exposes typed endpoints that the client calls via RPC. Models are defined in YAML and generate Dart classes for both server and client. The server uses PostgreSQL for persistence and includes an ORM, caching, real-time streaming, file uploads, scheduling, logging, and a built-in web server (Relic).
flutter doctor)docker-compose.yaml)dart pub global activate serverpod_cli
serverpod # verify
serverpod create my_project
Project name must be lowercase with underscores (valid Dart package name). Creates:
my_project_server/ — server codemy_project_client/ — generated client (do not edit)my_project_flutter/ — Flutter appThen fetch dependencies: dart pub get from project root.
my_project/
├── my_project_server/
│ ├── lib/ # Endpoints, models, business logic
│ ├── config/ # development.yaml, production.yaml, passwords.yaml
│ ├── bin/main.dart # Entry point
│ └── docker-compose.yaml # Local PostgreSQL
├── my_project_client/ # Generated client (do not edit)
└── my_project_flutter/ # Flutter app
Run serverpod generate after adding or changing endpoints or models.
docker compose up (detached: -d; stop: docker compose down).cd my_project_server && dart run bin/main.dart --apply-migrations. Subsequent runs (no schema changes): dart run bin/main.dart. API: http://localhost:8080, web server: http://localhost:8082.cd my_project_flutter && flutter run -d chrome. For Android emulator, the app uses 10.0.2.2; for a device on the network, set publicHost in config/development.yaml to the machine's IP.Lightweight setup without PostgreSQL: serverpod create myminipod --mini. Includes remote method calls, models, streaming, logging, and caching — no database ORM, scheduling, Insights, file uploads, health checks, or Relic web server. Start with dart run bin/main.dart (no Docker). Upgrade to full Serverpod later with serverpod create . from the server directory.