Skip to main content
Version: 4.0.0

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​

warning

If you installed an earlier version of Serverpod with dart pub global activate, remove it before you install:

$ dart pub global deactivate serverpod_cli
  1. Install the Serverpod CLI:

    $ dart install serverpod_cli

    The install ends with a warning that its folder is not on your PATH. The next step fixes that.

  2. To make the serverpod command available in new terminals, add the Dart install directory to your PATH:

    Run this in your terminal:

    $ echo 'export PATH="$PATH:$HOME/Library/Application Support/Dart/install/bin"' >> ~/.zshrc
  3. Open a new terminal and verify the installation:

    $ serverpod

    You'll see a list of Serverpod commands. On the first run, Serverpod also opens a welcome page in your browser.

Create your project​

  1. Create a new Serverpod project:

    $ serverpod quickstart my_project
  2. 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.

  3. Open the project's root folder, my_project, in your editor.

important

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:

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.

The agent will start building your app. It will manage your database and perform a hot reload when the app is complete.

tip
  • If your app uses authentication, the verification code appears as an alert in the terminal running serverpod start. Press the C key to copy the code.
  • If the agent fails to reload the app, press the R key in the terminal running serverpod start to 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.

  1. Create an account in the Serverpod Cloud Console.

  2. Open a second terminal. From the project folder, run:

    $ serverpod cloud launch
  3. Select your account from the browser window that opens, then return to your terminal once you see Login successful.

  4. When the terminal asks Open the browser and create a new Serverpod Cloud project?, press Enter. Your browser opens the project creation page.

  5. 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.

  6. 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​

Happy building with Serverpod 4!