Quickstart
Build and deploy a full-stack Flutter and Serverpod app, hosted on the web, in 10–15 minutes.
Prerequisites
- Flutter 3.44.4 or later (which includes Dart 3.12.2 or later). To check your version, run
flutter doctor. - An AI coding editor, such as Claude Code, Cursor, or Antigravity.
Install Serverpod
If you installed an earlier version of Serverpod with dart pub global activate, remove it before you install:
$ dart pub global deactivate serverpod_cli
-
Install the Serverpod CLI:
$ dart install serverpod_cliThe install ends with a warning that its folder is not on your
PATH. The next step fixes that. -
To make the
serverpodcommand available in new terminals, add the Dart install directory to yourPATH:- macOS
- Linux
- Windows
Run this in your terminal:
$ echo 'export PATH="$PATH:$HOME/Library/Application Support/Dart/install/bin"' >> ~/.zshrcIf your shell is bash, run:
$ echo 'export PATH="$PATH:${XDG_STATE_HOME:-$HOME/.local/state}/Dart/install/bin"' >> ~/.bashrcIf your shell is zsh, run:
$ echo 'export PATH="$PATH:${XDG_STATE_HOME:-$HOME/.local/state}/Dart/install/bin"' >> ~/.zshrcIf your shell is fish, run:
$ fish_add_path ~/.local/state/Dart/install/binRun this in PowerShell:
[Environment]::SetEnvironmentVariable("Path", [Environment]::GetEnvironmentVariable("Path", "User") + ";$env:LOCALAPPDATA\Dart\install\bin", "User") -
Open a new terminal and verify the installation:
$ serverpodYou'll see a list of Serverpod commands. On the first run, Serverpod also opens a welcome page in your browser.
Create your project
-
Create a new Serverpod project:
$ serverpod quickstart my_project -
On the interactive screen, use the arrow keys to move to your editor or agent, press Space to select it, then press Enter to create the project.
-
Open the project's root folder,
my_project, in your editor.
If you use Cursor, turn on the Serverpod and Dart MCP servers. Open Customize in the sidebar, click MCPs, and turn on both servers.
Start your server and app
In your terminal, go to the project folder and run serverpod start:
$ cd my_project
$ serverpod start
This starts your backend server, Flutter app, and database. When startup is finished, the sample app opens in your browser. Type your name and press Enter. The server responds with a personalized greeting, Hello [your_name].
Keep this terminal running. It watches your files and reloads your app whenever you save a change.
Build your app
Instruct your agent to build your app. Here are a few prompts that you can try:
- Job board
- CRM
- Social network
Build a professional job marketplace where employers post openings and manage applications, while job seekers browse listings. Use an editorial-inspired design with bold typography.
Build a modern CRM for a B2B sales team. Users can manage companies, contacts, and deals. Use a sleek dark theme with vibrant accent colors, compact layouts, and data-rich dashboards.
Build a modern social network where users share posts, follow each other, comment, and react. Give it a bold consumer-app style with colorful gradients, large avatars, and playful animations.
The agent will start building your app. It will manage your database and perform a hot reload when the app is complete.
- If your app uses authentication, the verification code appears as an alert in the terminal running
serverpod start. Press theCkey to copy the code. - If the agent fails to reload the app, press the
Rkey in the terminal runningserverpod startto force a restart of the server and the app.
Deploy your app to Serverpod Cloud
Deploy your app to Serverpod Cloud, the hosting platform run by the Serverpod team, to make it publicly accessible. Your first project includes a one-month free trial with no credit card required.
-
Create an account in the Serverpod Cloud Console.
-
Open a second terminal. From the project folder, run:
$ serverpod cloud launch -
Select your account from the browser window that opens, then return to your terminal once you see Login successful.
-
When the terminal asks Open the browser and create a new Serverpod Cloud project?, press Enter. Your browser opens the project creation page.
-
The Console suggests a Project ID, which becomes your public URL. Change it if the Console says the name is taken, keep the Starter plan, and click Launch Project.
-
Return to your terminal while the CLI packages and deploys your app.
When rollout finishes, your web app is live at https://<project-id>.serverpod.space. To deploy updates later, run serverpod cloud launch again from your project folder.
Next steps
- Learn how Serverpod works: See how your agent builds with Serverpod, and how endpoints, data models, and the database fit together.
- Monitor your app: Use the Logs, Sessions, and Metrics tabs in the Serverpod Cloud Console.
- Have feedback or questions? Tell us on Discord or open an issue on GitHub. Pull requests are welcome.
Happy building with Serverpod 4!