Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 3 additions & 20 deletions docs/04-get-started/01-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,36 +19,18 @@ $ flutter doctor

::::

Serverpod supports **SQLite** as a database, which means you can develop locally without installing Docker or running a separate database server. You can also use **Postgres** which includes support for vectors and other advanced features.

<details>

<summary>Using **Postgres** locally instead of SQLite</summary>

If you want to use Postgres rather than SQLite on your machine, install **[Docker](https://docs.docker.com/get-docker/)** and use it to run PostgreSQL locally. Each Serverpod project ships with its own `docker-compose.yaml`, so you do not need to assemble custom containers. The **[Getting Started](../05-build-your-first-app/01-creating-endpoints.md)** guide walks you through the details.

Check your Docker installation by running the following command in your terminal:

```bash
$ docker info
```

If you are using Docker Desktop and you get an error, make sure that Docker is running. You can check this by looking for the Docker icon in your system tray or taskbar. If it's not running, start Docker Desktop and try again.

</details>

### Install Serverpod

Serverpod is installed using the Dart package manager. To install Serverpod, run the following command in your terminal:

```txt
$ dart install serverpod_cli 3.5.0-beta.6
$ dart install serverpod_cli 3.5.0-beta.9
```

This command will install the Serverpod command-line interface (CLI) globally on your machine. You can verify the installation by running:

```bash
$ serverpod
$ serverpod version
```

If everything is correctly configured, the help for the `serverpod` command is now displayed.
Expand All @@ -66,6 +48,7 @@ $ dart pub global deactivate serverpod_cli
### Install the VS Code extension (recommended)

The Serverpod VS Code extension makes it easy to work with your Serverpod projects. It provides real-time diagnostics and syntax highlighting for model files in your project.

![Serverpod extension](/img/syntax-highlighting.png)

You can **[install the extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod)** from the VS Code Marketplace or search for _Serverpod_ from inside VS Code.
Expand Down
38 changes: 23 additions & 15 deletions docs/04-get-started/02-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';

# Quickstart

In this tutorial we will walk through creating a full-stack app with Flutter and Serverpod and deploying it to the cloud as a web app. **You will have an app up and hosted within 10–15 minutes.**
In this tutorial we will walk through creating a full-stack app with Flutter and Serverpod and deploying it to the cloud as a web app. **You will have an app up and hosted within 10–15 minutes.** We have tested the default setup with Antigravity, Cursor, and Claude Code, but most agentic editors will work.

:::info

Expand All @@ -21,27 +21,31 @@ Before we start, make sure that you have [Serverpod installed](./installation).

## Create the project

Use Serverpod's `create` command to create a new project. The `create` command is interactive and will guide you through the setup process. Create the project with all the default settings. (Just press Enter.)
Use Serverpod's `create` command to create a new project. The `create` command is interactive and will guide you through the setup process.

```bash
serverpod create my_project
$ serverpod create my_project
```

Next, open your newly created project with your favorite AI agent. (Open the root folder of the full project—for example, `my_project`—which includes the server, client, and Flutter app.) We have tested the default setup with Antigravity, Cursor, and Claude Code.
Create the project with all the default settings. Just select which editor/agent you are planning to use. Hit the Enter key to create the project.

If required by your editor, enable the MCP servers for Serverpod and Dart.
Next, open your newly created project with your favorite AI powered editor. Open the root folder of the full project, for example, `my_project`, which includes the server, client, and Flutter app.
Comment thread
vlidholt marked this conversation as resolved.

:::important

If you are using Cursor, you will need to **enable the MCP server** in your project settings (_Cursor Settings_ > _Tools & MCPs_).

:::

## Start the server and the app

Start the server by opening up a terminal window and running the `serverpod start` command:
Start the server and the Flutter app by opening up a terminal window and running the `serverpod start` command:
Comment thread
vlidholt marked this conversation as resolved.

```bash
serverpod start
$ serverpod start
```

When the server is running, start the Flutter app. Select _Chrome_ as the Flutter target (it's located at the bottom-right corner of the window). Open the `main.dart` file in the `my_project_flutter/lib/` directory. Click the _Run_ button above the `main` method.

After your app has finished building, it will open in a new window. Try it out by entering your name and clicking the send button.
After the server has started and your app has finished building, it will open in a new window. Try it out by entering your name and clicking the send button.

## Build your app

Expand All @@ -67,9 +71,13 @@ Instruct the agent to build your app. Here are a few simple prompts that you can

---

The server will automatically hot reload any changes made by the AI agent. However, if the agent modifies the database, you may need to create and apply the migrations. You can do this in the server's console by hitting the `M` key (Create Migration), followed by the `A` key (Apply Migration).
The agent will start building your app. It will manage your database and perform a hot reload when the app is complete.

To reload the app, hit the 🔄 hot restart button in the editor.
:::tip

If the agent fails to reload the app, you can always hit the `R` key to force a restart of the server and the app.

:::

## Deploy the app to the cloud

Expand All @@ -78,19 +86,19 @@ To deploy your app to Serverpod Cloud, you will need to create an account and se
Install the Serverpod Cloud command line tools:

```txt
dart install serverpod_cloud_cli
$ dart install serverpod_cloud_cli
```

With the Serverpod Cloud project set up and the CLI tools installed, you can deploy your backend and web app using the `scloud launch` command:

```txt
scloud launch
$ scloud launch
```

After the project has been uploaded for the first time, use the `deploy` command whenever you make changes to your project:

```txt
scloud deploy
$ scloud deploy
```

:::tip
Expand Down
Loading