├── static ├── .nojekyll └── img │ ├── favicon.ico │ ├── favicon.png │ ├── docusaurus.png │ ├── 1-hosted-zone.jpg │ ├── gcp │ ├── 3-dns-zone.jpg │ ├── 8-secrets.jpg │ ├── 6-record-set.jpg │ ├── 1-assign-roles.jpg │ ├── 10-add-network.jpg │ ├── 2-private-key.jpg │ ├── 4-dns-forward.jpg │ ├── 9-run-workflow.jpg │ ├── 0-create-project.jpg │ ├── 11-connect-database.jpg │ ├── 5-domain-verification.jpg │ └── 7-artifact-repository.jpg │ ├── 3-github-secrets.jpg │ ├── 4-github-workflow.jpg │ ├── 5-database-connect.jpg │ ├── syntax-highlighting.png │ ├── 2-request-certificate.jpg │ ├── 6-google-credentials.jpg │ ├── tutorial │ ├── localeDropdown.png │ ├── pixorama │ │ └── pixorama.png │ ├── docsVersionDropdown.png │ └── note-app │ │ ├── 02-note-class.png │ │ ├── 01-note-app-demo.mp4 │ │ ├── 02-note-class-v2.png │ │ ├── 03-note-create.mp4 │ │ └── 04-note-delete.mp4 │ ├── authentication │ ├── sign-in-widget.png │ └── providers │ │ ├── apple │ │ ├── 3-button.png │ │ ├── 1-xcode-add.png │ │ └── 2-xcode-sign-in-with-apple.png │ │ ├── google │ │ ├── 1-scopes.png │ │ ├── 3-button.png │ │ └── 2-credentials.png │ │ ├── firebase │ │ ├── 1-server-key.png │ │ └── 2-auth-provider.png │ │ └── email │ │ ├── 2-auth-email-dialog.png │ │ └── 1-sign-in-with-email-button.png │ └── getting-started │ ├── final-result.png │ ├── serverpod-web.png │ ├── flutter-example-web.png │ ├── endpoint-chrome-result.png │ └── flutter-web-ingredients.png ├── docs ├── 08-upgrading │ ├── _category_.json │ ├── 04-archive │ │ └── _category_.json │ └── 02-upgrade-from-mini.md ├── 07-deployments │ ├── _category_.json │ └── 06-community-supported-deployments.md ├── 06-concepts │ ├── 19-testing │ │ └── _category_.json │ ├── _category_.json │ ├── 18-webserver │ │ └── _category_.json │ ├── 06-database │ │ ├── _category_.json │ │ └── 03-relations │ │ │ └── _category_.json │ └── 11-authentication │ │ ├── 04-providers │ │ ├── _category_.json │ │ ├── 01-email │ │ │ └── _category_.json │ │ ├── 03-apple │ │ │ ├── _category_.json │ │ │ └── 02-configuration.md │ │ ├── 02-google │ │ │ └── _category_.json │ │ ├── 04-passkey │ │ │ ├── _category_.json │ │ │ └── 03-customizing-the-ui.md │ │ └── 10-custom-providers.md │ │ ├── _category_.json │ │ ├── 05-token-managers │ │ └── _category_.json │ │ └── 11-legacy │ │ ├── 04-providers │ │ └── _category_.json │ │ ├── _category_.json │ │ └── 03-working-with-users.md ├── 09-tools │ ├── _category_.json │ └── 02-lsp.md ├── 01-get-started │ └── _category_.json ├── 05-tutorials │ ├── 03-guides │ │ ├── _category_.json │ │ └── 04-authentication.md │ ├── _category_.json │ ├── 02-tutorials │ │ ├── _category_.json │ │ ├── 01-fundamentals.md │ │ └── 03-ai-and-rag.md │ └── 01-academy.md └── 04-support.md ├── versioned_docs ├── version-1.2.0 │ ├── 12-upgrading │ │ └── _category_.json │ ├── 06-deployments │ │ └── _category_.json │ ├── 03-tutorials │ │ ├── _category_.json │ │ ├── 03-code-example.md │ │ └── 04-authentication.md │ ├── 05-concepts │ │ ├── _category_.json │ │ ├── 06-database │ │ │ ├── _category_.json │ │ │ ├── 03-relations │ │ │ │ └── _category_.json │ │ │ └── 08-transactions.md │ │ ├── 10-authentication │ │ │ ├── 04-providers │ │ │ │ └── _category_.json │ │ │ └── _category_.json │ │ ├── 08-logging.md │ │ └── 15-backward-compatibility.md │ ├── 10-roadmap.md │ └── 09-lsp.md ├── version-2.0.0 │ ├── 12-upgrading │ │ └── _category_.json │ ├── 06-deployments │ │ └── _category_.json │ ├── 03-tutorials │ │ ├── _category_.json │ │ ├── 03-code-example.md │ │ └── 04-authentication.md │ ├── 05-concepts │ │ ├── _category_.json │ │ ├── 06-database │ │ │ ├── _category_.json │ │ │ ├── 03-relations │ │ │ │ └── _category_.json │ │ │ └── 08-transactions.md │ │ ├── 10-authentication │ │ │ ├── 04-providers │ │ │ │ └── _category_.json │ │ │ └── _category_.json │ │ ├── 15-backward-compatibility.md │ │ └── 08-logging.md │ ├── 07-tools │ │ ├── _category_.json │ │ └── 03-lsp.md │ └── 10-roadmap.md ├── version-2.1.0 │ ├── 08-upgrading │ │ ├── _category_.json │ │ └── 01-upgrade-from-mini.md │ ├── 07-deployments │ │ └── _category_.json │ ├── 05-tutorials │ │ ├── _category_.json │ │ ├── 03-code-example.md │ │ └── 04-authentication.md │ ├── 06-concepts │ │ ├── _category_.json │ │ ├── 06-database │ │ │ ├── _category_.json │ │ │ ├── 03-relations │ │ │ │ └── _category_.json │ │ │ └── 08-transactions.md │ │ ├── 11-authentication │ │ │ ├── 04-providers │ │ │ │ └── _category_.json │ │ │ └── _category_.json │ │ ├── 17-backward-compatibility.md │ │ └── 09-logging.md │ ├── 09-tools │ │ ├── _category_.json │ │ └── 02-lsp.md │ └── 04-support.md ├── version-2.2.0 │ ├── 08-upgrading │ │ ├── _category_.json │ │ └── 01-upgrade-from-mini.md │ ├── 07-deployments │ │ └── _category_.json │ ├── 05-tutorials │ │ ├── _category_.json │ │ ├── 03-code-example.md │ │ └── 04-authentication.md │ ├── 06-concepts │ │ ├── _category_.json │ │ ├── 19-testing │ │ │ └── _category_.json │ │ ├── 06-database │ │ │ ├── _category_.json │ │ │ ├── 03-relations │ │ │ │ └── _category_.json │ │ │ └── 08-transactions.md │ │ ├── 11-authentication │ │ │ ├── 04-providers │ │ │ │ └── _category_.json │ │ │ └── _category_.json │ │ └── 17-backward-compatibility.md │ ├── 09-tools │ │ ├── _category_.json │ │ └── 02-lsp.md │ └── 04-support.md ├── version-2.3.0 │ ├── 08-upgrading │ │ ├── _category_.json │ │ └── 01-upgrade-from-mini.md │ ├── 07-deployments │ │ ├── _category_.json │ │ └── 06-community-supported-deployments.md │ ├── 05-tutorials │ │ ├── _category_.json │ │ ├── 03-code-example.md │ │ └── 04-authentication.md │ ├── 06-concepts │ │ ├── _category_.json │ │ ├── 19-testing │ │ │ └── _category_.json │ │ ├── 06-database │ │ │ ├── _category_.json │ │ │ └── 03-relations │ │ │ │ └── _category_.json │ │ ├── 11-authentication │ │ │ ├── 04-providers │ │ │ │ └── _category_.json │ │ │ └── _category_.json │ │ └── 17-backward-compatibility.md │ ├── 09-tools │ │ ├── _category_.json │ │ └── 02-lsp.md │ ├── 04-support.md │ └── 10-contribute.md ├── version-2.4.0 │ ├── 08-upgrading │ │ ├── _category_.json │ │ └── 01-upgrade-from-mini.md │ ├── 07-deployments │ │ ├── _category_.json │ │ └── 06-community-supported-deployments.md │ ├── 05-tutorials │ │ ├── _category_.json │ │ ├── 03-code-example.md │ │ └── 04-authentication.md │ ├── 06-concepts │ │ ├── _category_.json │ │ ├── 19-testing │ │ │ └── _category_.json │ │ ├── 06-database │ │ │ ├── _category_.json │ │ │ └── 03-relations │ │ │ │ └── _category_.json │ │ ├── 11-authentication │ │ │ ├── 04-providers │ │ │ │ └── _category_.json │ │ │ └── _category_.json │ │ └── 17-backward-compatibility.md │ ├── 09-tools │ │ ├── _category_.json │ │ └── 02-lsp.md │ ├── 04-support.md │ └── 10-contribute.md ├── version-2.5.0 │ ├── 08-upgrading │ │ ├── _category_.json │ │ └── 01-upgrade-from-mini.md │ ├── 07-deployments │ │ ├── _category_.json │ │ └── 06-community-supported-deployments.md │ ├── 01-get-started │ │ ├── _category_.json │ │ ├── 09-next-steps.md │ │ ├── 07-serializing-data.md │ │ ├── 01-overview.md │ │ ├── 06-working-with-endpoints.md │ │ └── 02-serverpod-vs-mini.md │ ├── 05-tutorials │ │ ├── _category_.json │ │ ├── 03-code-example.md │ │ └── 04-authentication.md │ ├── 06-concepts │ │ ├── _category_.json │ │ ├── 19-testing │ │ │ └── _category_.json │ │ ├── 06-database │ │ │ ├── _category_.json │ │ │ └── 03-relations │ │ │ │ └── _category_.json │ │ ├── 11-authentication │ │ │ ├── 04-providers │ │ │ │ └── _category_.json │ │ │ └── _category_.json │ │ └── 17-backward-compatibility.md │ ├── 09-tools │ │ ├── _category_.json │ │ └── 02-lsp.md │ ├── 04-support.md │ └── 10-contribute.md ├── version-2.6.0 │ ├── 08-upgrading │ │ ├── _category_.json │ │ └── 01-upgrade-from-mini.md │ ├── 07-deployments │ │ ├── _category_.json │ │ └── 06-community-supported-deployments.md │ ├── 01-get-started │ │ ├── _category_.json │ │ ├── 09-next-steps.md │ │ ├── 07-serializing-data.md │ │ ├── 01-overview.md │ │ ├── 06-working-with-endpoints.md │ │ └── 02-serverpod-vs-mini.md │ ├── 05-tutorials │ │ ├── _category_.json │ │ ├── 03-code-example.md │ │ └── 04-authentication.md │ ├── 06-concepts │ │ ├── _category_.json │ │ ├── 19-testing │ │ │ └── _category_.json │ │ ├── 06-database │ │ │ ├── _category_.json │ │ │ └── 03-relations │ │ │ │ └── _category_.json │ │ └── 11-authentication │ │ │ ├── 04-providers │ │ │ └── _category_.json │ │ │ └── _category_.json │ ├── 09-tools │ │ ├── _category_.json │ │ └── 02-lsp.md │ ├── 04-support.md │ └── 10-contribute.md ├── version-2.7.0 │ ├── 08-upgrading │ │ ├── _category_.json │ │ └── 01-upgrade-from-mini.md │ ├── 07-deployments │ │ ├── _category_.json │ │ └── 06-community-supported-deployments.md │ ├── 05-tutorials │ │ ├── _category_.json │ │ ├── 03-code-example.md │ │ └── 04-authentication.md │ ├── 06-concepts │ │ ├── _category_.json │ │ ├── 19-testing │ │ │ └── _category_.json │ │ ├── 06-database │ │ │ ├── _category_.json │ │ │ └── 03-relations │ │ │ │ └── _category_.json │ │ └── 11-authentication │ │ │ ├── 04-providers │ │ │ └── _category_.json │ │ │ └── _category_.json │ ├── 09-tools │ │ ├── _category_.json │ │ └── 02-lsp.md │ ├── 01-get-started │ │ └── _category_.json │ ├── 04-support.md │ └── 10-contribute.md ├── version-2.8.0 │ ├── 08-upgrading │ │ ├── _category_.json │ │ └── 01-upgrade-from-mini.md │ ├── 07-deployments │ │ ├── _category_.json │ │ └── 06-community-supported-deployments.md │ ├── 05-tutorials │ │ ├── _category_.json │ │ ├── 03-code-example.md │ │ └── 04-authentication.md │ ├── 06-concepts │ │ ├── _category_.json │ │ ├── 19-testing │ │ │ └── _category_.json │ │ ├── 06-database │ │ │ ├── _category_.json │ │ │ └── 03-relations │ │ │ │ └── _category_.json │ │ └── 11-authentication │ │ │ ├── 04-providers │ │ │ └── _category_.json │ │ │ └── _category_.json │ ├── 09-tools │ │ ├── _category_.json │ │ └── 02-lsp.md │ ├── 01-get-started │ │ └── _category_.json │ ├── 04-support.md │ └── 10-contribute.md ├── version-1.0.0 │ ├── 05-deployments │ │ └── _category_.json │ ├── 04-concepts │ │ ├── _category_.json │ │ ├── 05-logging.md │ │ └── 12-backward-compatibility.md │ └── 06-roadmap.md ├── version-1.1.0 │ ├── 05-deployments │ │ └── _category_.json │ ├── 04-concepts │ │ ├── _category_.json │ │ ├── 07-logging.md │ │ └── 14-backward-compatibility.md │ ├── 07-roadmap.md │ └── 06-insights.md ├── version-1.1.1 │ ├── 06-deployments │ │ └── _category_.json │ ├── 03-tutorials │ │ ├── _category_.json │ │ ├── 03-code-example.md │ │ └── 04-authentication.md │ ├── 05-concepts │ │ ├── _category_.json │ │ ├── 09-authentication │ │ │ ├── 04-providers │ │ │ │ ├── _category_.json │ │ │ │ └── 05-firebase.md │ │ │ └── _category_.json │ │ ├── 07-logging.md │ │ └── 14-backward-compatibility.md │ ├── 08-roadmap.md │ └── 07-insights.md ├── version-2.9.0 │ ├── 08-upgrading │ │ ├── _category_.json │ │ └── 01-upgrade-from-mini.md │ ├── 07-deployments │ │ ├── _category_.json │ │ └── 06-community-supported-deployments.md │ ├── 06-concepts │ │ ├── _category_.json │ │ ├── 19-testing │ │ │ └── _category_.json │ │ ├── 06-database │ │ │ ├── _category_.json │ │ │ └── 03-relations │ │ │ │ └── _category_.json │ │ └── 11-authentication │ │ │ ├── 04-providers │ │ │ └── _category_.json │ │ │ └── _category_.json │ ├── 01-get-started │ │ └── _category_.json │ ├── 09-tools │ │ ├── _category_.json │ │ └── 02-lsp.md │ ├── 05-tutorials │ │ ├── 03-guides │ │ │ ├── _category_.json │ │ │ └── 04-authentication.md │ │ ├── _category_.json │ │ ├── 02-tutorials │ │ │ ├── _category_.json │ │ │ ├── 01-fundamentals.md │ │ │ └── 03-ai-and-rag.md │ │ └── 01-academy.md │ └── 04-support.md └── version-3.0.0 │ ├── 08-upgrading │ ├── _category_.json │ ├── 04-archive │ │ └── _category_.json │ └── 02-upgrade-from-mini.md │ ├── 07-deployments │ ├── _category_.json │ └── 06-community-supported-deployments.md │ ├── 06-concepts │ ├── _category_.json │ ├── 19-testing │ │ └── _category_.json │ ├── 18-webserver │ │ └── _category_.json │ ├── 06-database │ │ ├── _category_.json │ │ └── 03-relations │ │ │ └── _category_.json │ └── 11-authentication │ │ ├── 04-providers │ │ ├── _category_.json │ │ ├── 01-email │ │ │ └── _category_.json │ │ ├── 02-google │ │ │ └── _category_.json │ │ ├── 03-apple │ │ │ ├── _category_.json │ │ │ └── 02-configuration.md │ │ ├── 04-passkey │ │ │ ├── _category_.json │ │ │ └── 03-customizing-the-ui.md │ │ └── 10-custom-providers.md │ │ ├── _category_.json │ │ ├── 05-token-managers │ │ └── _category_.json │ │ └── 11-legacy │ │ ├── 04-providers │ │ └── _category_.json │ │ └── _category_.json │ ├── 01-get-started │ └── _category_.json │ ├── 09-tools │ ├── _category_.json │ └── 02-lsp.md │ ├── 05-tutorials │ ├── 03-guides │ │ ├── _category_.json │ │ └── 04-authentication.md │ ├── _category_.json │ ├── 02-tutorials │ │ ├── _category_.json │ │ ├── 01-fundamentals.md │ │ └── 03-ai-and-rag.md │ └── 01-academy.md │ └── 04-support.md ├── util └── deploy ├── babel.config.js ├── .prettierrc ├── blog ├── 2021-08-26-welcome │ ├── docusaurus-plushie-banner.jpeg │ └── index.md ├── 2019-05-28-first-blog-post.md ├── authors.yml └── 2021-08-01-mdx-blog-post.mdx ├── versioned_sidebars ├── version-1.0.0-sidebars.json ├── version-1.1.0-sidebars.json ├── version-1.1.1-sidebars.json ├── version-1.2.0-sidebars.json ├── version-2.0.0-sidebars.json ├── version-2.1.0-sidebars.json ├── version-2.2.0-sidebars.json ├── version-2.3.0-sidebars.json ├── version-2.4.0-sidebars.json ├── version-2.5.0-sidebars.json ├── version-2.6.0-sidebars.json ├── version-2.7.0-sidebars.json ├── version-2.8.0-sidebars.json ├── version-2.9.0-sidebars.json └── version-3.0.0-sidebars.json ├── .markdownlint.yaml ├── src ├── components │ └── HomepageFeatures │ │ └── styles.module.css ├── pages │ └── index.module.css └── css │ └── custom.css ├── versions.json ├── .github ├── ISSUE_TEMPLATE │ └── config.yml ├── dependabot.yml └── workflows │ ├── title-validation.yml │ └── test-build.yml ├── .gitignore ├── sidebars.js ├── Makefile └── package.json /static/.nojekyll: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/08-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🔄 Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /docs/07-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🚢 Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /docs/08-upgrading/04-archive/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Archive" 3 | } 4 | -------------------------------------------------------------------------------- /docs/06-concepts/19-testing/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Testing", 3 | "collapsed": true 4 | } -------------------------------------------------------------------------------- /docs/06-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "📚 Reference", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /docs/09-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🧰 Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/12-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/12-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/08-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/08-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/08-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/08-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/08-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/08-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/08-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/08-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /docs/01-get-started/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🚀 Getting started", 3 | "collapsed": false 4 | } -------------------------------------------------------------------------------- /docs/05-tutorials/03-guides/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "📘 Guides", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /docs/05-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🎓 Learn Serverpod", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /static/img/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/favicon.ico -------------------------------------------------------------------------------- /static/img/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/favicon.png -------------------------------------------------------------------------------- /util/deploy: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | set -e 3 | 4 | npm run build 5 | cp -R build/ ../serverpod.github.io/docs 6 | -------------------------------------------------------------------------------- /versioned_docs/version-1.0.0/05-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.0/05-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/06-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/06-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/06-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/07-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/07-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/07-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/07-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/07-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/07-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/07-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/07-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/08-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🔄 Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/08-upgrading/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🔄 Upgrading" 3 | } 4 | -------------------------------------------------------------------------------- /docs/05-tutorials/02-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🎥 Tutorials", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /docs/06-concepts/18-webserver/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Web server", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /static/img/docusaurus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/docusaurus.png -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/07-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🚢 Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/07-deployments/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🚢 Deploying Serverpod" 3 | } 4 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/08-upgrading/04-archive/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Archive" 3 | } 4 | -------------------------------------------------------------------------------- /babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: [require.resolve('@docusaurus/core/lib/babel/preset')], 3 | }; 4 | -------------------------------------------------------------------------------- /docs/06-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /static/img/1-hosted-zone.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/1-hosted-zone.jpg -------------------------------------------------------------------------------- /static/img/gcp/3-dns-zone.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/3-dns-zone.jpg -------------------------------------------------------------------------------- /static/img/gcp/8-secrets.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/8-secrets.jpg -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/01-get-started/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Get Started", 3 | "position": 1 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/01-get-started/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Get Started", 3 | "position": 1 4 | } -------------------------------------------------------------------------------- /static/img/3-github-secrets.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/3-github-secrets.jpg -------------------------------------------------------------------------------- /static/img/gcp/6-record-set.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/6-record-set.jpg -------------------------------------------------------------------------------- /versioned_docs/version-1.0.0/04-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Concepts", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.0/04-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Concepts", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/03-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tutorials", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/05-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Concepts", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/03-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tutorials", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/05-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Concepts", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/03-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tutorials", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/05-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Concepts", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/07-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/05-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tutorials", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/06-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Reference", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/09-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/05-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tutorials", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/06-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Reference", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/09-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/05-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tutorials", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/06-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Reference", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/09-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/05-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tutorials", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/06-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Reference", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/09-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/05-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tutorials", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/06-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Reference", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/09-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/05-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tutorials", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/06-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Reference", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/09-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/05-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tutorials", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/06-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Reference", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/09-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/05-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tutorials", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/06-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Reference", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/09-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/06-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "📚 Reference", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "📚 Reference", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /static/img/4-github-workflow.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/4-github-workflow.jpg -------------------------------------------------------------------------------- /static/img/5-database-connect.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/5-database-connect.jpg -------------------------------------------------------------------------------- /static/img/gcp/1-assign-roles.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/1-assign-roles.jpg -------------------------------------------------------------------------------- /static/img/gcp/10-add-network.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/10-add-network.jpg -------------------------------------------------------------------------------- /static/img/gcp/2-private-key.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/2-private-key.jpg -------------------------------------------------------------------------------- /static/img/gcp/4-dns-forward.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/4-dns-forward.jpg -------------------------------------------------------------------------------- /static/img/gcp/9-run-workflow.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/9-run-workflow.jpg -------------------------------------------------------------------------------- /static/img/syntax-highlighting.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/syntax-highlighting.png -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/06-concepts/19-testing/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Testing", 3 | "collapsed": true 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/06-concepts/19-testing/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Testing", 3 | "collapsed": true 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/06-concepts/19-testing/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Testing", 3 | "collapsed": true 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/06-concepts/19-testing/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Testing", 3 | "collapsed": true 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/06-concepts/19-testing/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Testing", 3 | "collapsed": true 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/01-get-started/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Getting Started", 3 | "collapsed": false 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/06-concepts/19-testing/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Testing", 3 | "collapsed": true 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/01-get-started/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Getting Started", 3 | "collapsed": false 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/06-concepts/19-testing/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Testing", 3 | "collapsed": true 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/01-get-started/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🚀 Getting started", 3 | "collapsed": false 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/06-concepts/19-testing/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Testing", 3 | "collapsed": true 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/09-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🧰 Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/01-get-started/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🚀 Getting started", 3 | "collapsed": false 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/19-testing/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Testing", 3 | "collapsed": true 4 | } -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/09-tools/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🧰 Tools", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /docs/06-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /static/img/2-request-certificate.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/2-request-certificate.jpg -------------------------------------------------------------------------------- /static/img/6-google-credentials.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/6-google-credentials.jpg -------------------------------------------------------------------------------- /static/img/gcp/0-create-project.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/0-create-project.jpg -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/05-tutorials/03-guides/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "📘 Guides", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/05-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🎓 Learn Serverpod", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/05-tutorials/03-guides/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "📘 Guides", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/05-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🎓 Learn Serverpod", 3 | "collapsed": false 4 | } 5 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/04-providers/01-email/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Email", 3 | "collapsed": true 4 | } 5 | 6 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/04-providers/03-apple/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Apple", 3 | "collapsed": true 4 | } 5 | 6 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/05-token-managers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Token Managers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/11-legacy/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/11-legacy/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Legacy Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /static/img/gcp/11-connect-database.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/11-connect-database.jpg -------------------------------------------------------------------------------- /static/img/tutorial/localeDropdown.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/tutorial/localeDropdown.png -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/05-tutorials/02-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🎥 Tutorials", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/05-tutorials/02-tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "🎥 Tutorials", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/18-webserver/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Web server", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/04-providers/02-google/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Google", 3 | "collapsed": true 4 | } 5 | 6 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/04-providers/04-passkey/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Passkey", 3 | "collapsed": true 4 | } 5 | 6 | -------------------------------------------------------------------------------- /static/img/gcp/5-domain-verification.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/5-domain-verification.jpg -------------------------------------------------------------------------------- /static/img/gcp/7-artifact-repository.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/gcp/7-artifact-repository.jpg -------------------------------------------------------------------------------- /static/img/tutorial/pixorama/pixorama.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/tutorial/pixorama/pixorama.png -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/05-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/05-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/06-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/06-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/06-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/06-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/06-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/06-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/06-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/06-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/06-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/06-database/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Database", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /static/img/authentication/sign-in-widget.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/authentication/sign-in-widget.png -------------------------------------------------------------------------------- /static/img/getting-started/final-result.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/getting-started/final-result.png -------------------------------------------------------------------------------- /static/img/getting-started/serverpod-web.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/getting-started/serverpod-web.png -------------------------------------------------------------------------------- /static/img/tutorial/docsVersionDropdown.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/tutorial/docsVersionDropdown.png -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "semi": true, 3 | "singleQuote": true, 4 | "trailingComma": "es5", 5 | "useTabs": false, 6 | "bracketSpacing": true 7 | } 8 | -------------------------------------------------------------------------------- /static/img/tutorial/note-app/02-note-class.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/tutorial/note-app/02-note-class.png -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/05-concepts/09-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/05-concepts/09-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/05-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/05-concepts/10-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/05-concepts/10-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/05-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/05-concepts/10-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/05-concepts/10-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/06-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/06-concepts/11-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/06-concepts/11-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/06-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/06-concepts/11-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/06-concepts/11-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/06-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/06-concepts/11-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/06-concepts/11-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/06-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/06-concepts/11-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/06-concepts/11-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/06-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/06-concepts/11-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/06-concepts/11-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/06-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/06-concepts/11-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/06-concepts/11-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/06-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/06-concepts/11-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/06-concepts/11-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/06-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/06-concepts/11-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/06-concepts/11-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/06-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/06-concepts/11-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/06-concepts/11-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/06-database/03-relations/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Relations", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /static/img/tutorial/note-app/01-note-app-demo.mp4: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/tutorial/note-app/01-note-app-demo.mp4 -------------------------------------------------------------------------------- /static/img/tutorial/note-app/02-note-class-v2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/tutorial/note-app/02-note-class-v2.png -------------------------------------------------------------------------------- /static/img/tutorial/note-app/03-note-create.mp4: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/tutorial/note-app/03-note-create.mp4 -------------------------------------------------------------------------------- /static/img/tutorial/note-app/04-note-delete.mp4: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/tutorial/note-app/04-note-delete.mp4 -------------------------------------------------------------------------------- /static/img/getting-started/flutter-example-web.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/getting-started/flutter-example-web.png -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/04-providers/01-email/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Email", 3 | "collapsed": true 4 | } 5 | 6 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/04-providers/02-google/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Google", 3 | "collapsed": true 4 | } 5 | 6 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/04-providers/03-apple/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Apple", 3 | "collapsed": true 4 | } 5 | 6 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/05-token-managers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Token Managers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/11-legacy/04-providers/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Providers", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/11-legacy/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Legacy Authentication", 3 | "collapsed": true 4 | } 5 | -------------------------------------------------------------------------------- /blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg -------------------------------------------------------------------------------- /static/img/authentication/providers/apple/3-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/authentication/providers/apple/3-button.png -------------------------------------------------------------------------------- /static/img/getting-started/endpoint-chrome-result.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/getting-started/endpoint-chrome-result.png -------------------------------------------------------------------------------- /static/img/getting-started/flutter-web-ingredients.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/getting-started/flutter-web-ingredients.png -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/04-providers/04-passkey/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "label": "Passkey", 3 | "collapsed": true 4 | } 5 | 6 | -------------------------------------------------------------------------------- /static/img/authentication/providers/google/1-scopes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/authentication/providers/google/1-scopes.png -------------------------------------------------------------------------------- /static/img/authentication/providers/google/3-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/authentication/providers/google/3-button.png -------------------------------------------------------------------------------- /versioned_sidebars/version-1.0.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /versioned_sidebars/version-1.1.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /versioned_sidebars/version-1.1.1-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /versioned_sidebars/version-1.2.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /versioned_sidebars/version-2.0.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /versioned_sidebars/version-2.1.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /versioned_sidebars/version-2.2.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /versioned_sidebars/version-2.3.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /versioned_sidebars/version-2.4.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | } 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /.markdownlint.yaml: -------------------------------------------------------------------------------- 1 | MD001: false 2 | MD013: false 3 | MD014: false 4 | MD024: false 5 | MD033: false # Allow inline HTML 6 | MD059: false # Allow non descriptive link text 7 | -------------------------------------------------------------------------------- /static/img/authentication/providers/apple/1-xcode-add.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/authentication/providers/apple/1-xcode-add.png -------------------------------------------------------------------------------- /static/img/authentication/providers/firebase/1-server-key.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/authentication/providers/firebase/1-server-key.png -------------------------------------------------------------------------------- /static/img/authentication/providers/google/2-credentials.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/authentication/providers/google/2-credentials.png -------------------------------------------------------------------------------- /static/img/authentication/providers/firebase/2-auth-provider.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/authentication/providers/firebase/2-auth-provider.png -------------------------------------------------------------------------------- /static/img/authentication/providers/email/2-auth-email-dialog.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/authentication/providers/email/2-auth-email-dialog.png -------------------------------------------------------------------------------- /static/img/authentication/providers/apple/2-xcode-sign-in-with-apple.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/authentication/providers/apple/2-xcode-sign-in-with-apple.png -------------------------------------------------------------------------------- /static/img/authentication/providers/email/1-sign-in-with-email-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/serverpod/serverpod_docs/HEAD/static/img/authentication/providers/email/1-sign-in-with-email-button.png -------------------------------------------------------------------------------- /src/components/HomepageFeatures/styles.module.css: -------------------------------------------------------------------------------- 1 | .features { 2 | display: flex; 3 | align-items: center; 4 | padding: 2rem 0; 5 | width: 100%; 6 | } 7 | 8 | .featureSvg { 9 | height: 200px; 10 | width: 200px; 11 | } 12 | -------------------------------------------------------------------------------- /versions.json: -------------------------------------------------------------------------------- 1 | [ 2 | "3.0.0", 3 | "2.9.0", 4 | "2.8.0", 5 | "2.7.0", 6 | "2.6.0", 7 | "2.5.0", 8 | "2.4.0", 9 | "2.3.0", 10 | "2.2.0", 11 | "2.1.0", 12 | "2.0.0", 13 | "1.2.0", 14 | "1.1.1", 15 | "1.1.0", 16 | "1.0.0" 17 | ] 18 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: Something missing or incorrect? 4 | url: https://github.com/serverpod/serverpod/issues/new/choose 5 | about: Please open an issue in the Serverpod repository for documentation corrections or suggestions. 6 | -------------------------------------------------------------------------------- /versioned_sidebars/version-2.5.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | }, 7 | { 8 | "type": "link", 9 | "label": "Changelog", 10 | "href": "https://pub.dev/packages/serverpod/changelog" 11 | } 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /versioned_sidebars/version-2.6.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | }, 7 | { 8 | "type": "link", 9 | "label": "Changelog", 10 | "href": "https://pub.dev/packages/serverpod/changelog" 11 | } 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /versioned_sidebars/version-2.7.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | }, 7 | { 8 | "type": "link", 9 | "label": "Changelog", 10 | "href": "https://pub.dev/packages/serverpod/changelog" 11 | } 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /versioned_sidebars/version-2.8.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | }, 7 | { 8 | "type": "link", 9 | "label": "Changelog", 10 | "href": "https://pub.dev/packages/serverpod/changelog" 11 | } 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /versioned_sidebars/version-2.9.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | }, 7 | { 8 | "type": "link", 9 | "label": "📝 Changelog", 10 | "href": "https://pub.dev/packages/serverpod/changelog" 11 | } 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /versioned_sidebars/version-3.0.0-sidebars.json: -------------------------------------------------------------------------------- 1 | { 2 | "tutorialSidebar": [ 3 | { 4 | "type": "autogenerated", 5 | "dirName": "." 6 | }, 7 | { 8 | "type": "link", 9 | "label": "📝 Changelog", 10 | "href": "https://pub.dev/packages/serverpod/changelog" 11 | } 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/04-providers/04-passkey/03-customizing-the-ui.md: -------------------------------------------------------------------------------- 1 | # Customizing the UI 2 | 3 | :::warning 4 | Flutter UI components for passkeys are not yet available. This section will be updated once official Flutter widgets are released. For now, you'll need to build custom UI using the generated client endpoints and WebAuthn APIs. 5 | ::: 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Dependencies 2 | /node_modules 3 | 4 | # Production 5 | /build 6 | 7 | # Generated files 8 | .docusaurus 9 | .cache-loader 10 | 11 | # Misc 12 | .DS_Store 13 | .env.local 14 | .env.development.local 15 | .env.test.local 16 | .env.production.local 17 | 18 | npm-debug.log* 19 | yarn-debug.log* 20 | yarn-error.log* 21 | settings.json 22 | .claude 23 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/04-providers/04-passkey/03-customizing-the-ui.md: -------------------------------------------------------------------------------- 1 | # Customizing the UI 2 | 3 | :::warning 4 | Flutter UI components for passkeys are not yet available. This section will be updated once official Flutter widgets are released. For now, you'll need to build custom UI using the generated client endpoints and WebAuthn APIs. 5 | ::: 6 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "npm" 4 | directory: "/" 5 | schedule: 6 | interval: "daily" 7 | versioning-strategy: "auto" 8 | open-pull-requests-limit: 5 9 | groups: 10 | docusaurus: 11 | patterns: 12 | - "*docusaurus*" 13 | react: 14 | patterns: 15 | - "*react*" 16 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/04-providers/10-custom-providers.md: -------------------------------------------------------------------------------- 1 | # Custom providers 2 | 3 | Serverpod's authentication module makes it easy to implement custom authentication providers. This allows you to leverage all the existing providers supplied by the module along with the specific providers your project requires. 4 | 5 | :::note 6 | This section is under development and will be updated soon. 7 | ::: 8 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.0/07-roadmap.md: -------------------------------------------------------------------------------- 1 | # Roadmap 2 | 3 | The Roadmap is up on Github. 4 | 5 | [View the roadmap here.](https://github.com/orgs/serverpod/projects/4/views/1) 6 | 7 | :::info 8 | 9 | If you want to suggest a new feature or report a bug, please [file an issue](https://github.com/serverpod/serverpod/issues) on Github. We're reviewing new issues and pull requests on a daily basis. 10 | 11 | ::: 12 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/08-roadmap.md: -------------------------------------------------------------------------------- 1 | # Roadmap 2 | 3 | The Roadmap is up on Github. 4 | 5 | [View the roadmap here.](https://github.com/orgs/serverpod/projects/4/views/1) 6 | 7 | :::info 8 | 9 | If you want to suggest a new feature or report a bug, please [file an issue](https://github.com/serverpod/serverpod/issues) on Github. We're reviewing new issues and pull requests on a daily basis. 10 | 11 | ::: 12 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/10-roadmap.md: -------------------------------------------------------------------------------- 1 | # Roadmap 2 | 3 | The Roadmap is up on Github. 4 | 5 | [View the roadmap here.](https://github.com/orgs/serverpod/projects/4/views/1) 6 | 7 | :::info 8 | 9 | If you want to suggest a new feature or report a bug, please [file an issue](https://github.com/serverpod/serverpod/issues) on Github. We're reviewing new issues and pull requests on a daily basis. 10 | 11 | ::: 12 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/10-roadmap.md: -------------------------------------------------------------------------------- 1 | # Roadmap 2 | 3 | The Roadmap is up on Github. 4 | 5 | [View the roadmap here.](https://github.com/orgs/serverpod/projects/4/views/1) 6 | 7 | :::info 8 | 9 | If you want to suggest a new feature or report a bug, please [file an issue](https://github.com/serverpod/serverpod/issues) on Github. We're reviewing new issues and pull requests on a daily basis. 10 | 11 | ::: 12 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/04-providers/10-custom-providers.md: -------------------------------------------------------------------------------- 1 | # Custom providers 2 | 3 | Serverpod's authentication module makes it easy to implement custom authentication providers. This allows you to leverage all the existing providers supplied by the module along with the specific providers your project requires. 4 | 5 | :::note 6 | This section is under development and will be updated soon. 7 | ::: 8 | -------------------------------------------------------------------------------- /blog/2019-05-28-first-blog-post.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: first-blog-post 3 | title: First Blog Post 4 | authors: 5 | name: Gao Wei 6 | title: Docusaurus Core Team 7 | url: https://github.com/wgao19 8 | image_url: https://github.com/wgao19.png 9 | tags: [hola, docusaurus] 10 | --- 11 | 12 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet 13 | -------------------------------------------------------------------------------- /src/pages/index.module.css: -------------------------------------------------------------------------------- 1 | /** 2 | * CSS files with the .module.css suffix will be treated as CSS modules 3 | * and scoped locally. 4 | */ 5 | 6 | .heroBanner { 7 | padding: 4rem 0; 8 | text-align: center; 9 | position: relative; 10 | overflow: hidden; 11 | } 12 | 13 | @media screen and (max-width: 996px) { 14 | .heroBanner { 15 | padding: 2rem; 16 | } 17 | } 18 | 19 | .buttons { 20 | display: flex; 21 | align-items: center; 22 | justify-content: center; 23 | } 24 | -------------------------------------------------------------------------------- /blog/authors.yml: -------------------------------------------------------------------------------- 1 | endi: 2 | name: Endilie Yacop Sucipto 3 | title: Maintainer of Docusaurus 4 | url: https://github.com/endiliey 5 | image_url: https://github.com/endiliey.png 6 | 7 | yangshun: 8 | name: Yangshun Tay 9 | title: Front End Engineer @ Facebook 10 | url: https://github.com/yangshun 11 | image_url: https://github.com/yangshun.png 12 | 13 | slorber: 14 | name: Sébastien Lorber 15 | title: Docusaurus maintainer 16 | url: https://sebastienlorber.com 17 | image_url: https://github.com/slorber.png 18 | -------------------------------------------------------------------------------- /docs/08-upgrading/02-upgrade-from-mini.md: -------------------------------------------------------------------------------- 1 | # Upgrade from Mini to full 2 | 3 | If you have started with Serverpod Mini, you can upgrade to the full Serverpod version anytime. Before you upgrade, it's good practice to back up your project, as some configuration files can be overwritten if you have manually created them. 4 | 5 | To upgrade your project, change directory into your server, then run: 6 | 7 | ```bash 8 | serverpod create . 9 | ``` 10 | 11 | Serverpod will now add the configuration files required for the full version. 12 | -------------------------------------------------------------------------------- /blog/2021-08-01-mdx-blog-post.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | slug: mdx-blog-post 3 | title: MDX Blog Post 4 | authors: [slorber] 5 | tags: [docusaurus] 6 | --- 7 | 8 | Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/). 9 | 10 | :::tip 11 | 12 | Use the power of React to create interactive blog posts. 13 | 14 | ```js 15 | 16 | ``` 17 | 18 | 19 | 20 | ::: 21 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/08-upgrading/01-upgrade-from-mini.md: -------------------------------------------------------------------------------- 1 | # Upgrade from Mini to full 2 | 3 | If you have started with Serverpod Mini, you can upgrade to the full Serverpod version anytime. Before you upgrade, it's good practice to back up your project, as some configuration files can be overwritten if you have manually created them. 4 | 5 | To upgrade your project, change directory into your server, then run: 6 | 7 | ```bash 8 | serverpod create . 9 | ``` 10 | 11 | Serverpod will now add the configuration files required for the full version. 12 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/08-upgrading/01-upgrade-from-mini.md: -------------------------------------------------------------------------------- 1 | # Upgrade from Mini to full 2 | 3 | If you have started with Serverpod Mini, you can upgrade to the full Serverpod version anytime. Before you upgrade, it's good practice to back up your project, as some configuration files can be overwritten if you have manually created them. 4 | 5 | To upgrade your project, change directory into your server, then run: 6 | 7 | ```bash 8 | serverpod create . 9 | ``` 10 | 11 | Serverpod will now add the configuration files required for the full version. 12 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/08-upgrading/01-upgrade-from-mini.md: -------------------------------------------------------------------------------- 1 | # Upgrade from Mini to full 2 | 3 | If you have started with Serverpod Mini, you can upgrade to the full Serverpod version anytime. Before you upgrade, it's good practice to back up your project, as some configuration files can be overwritten if you have manually created them. 4 | 5 | To upgrade your project, change directory into your server, then run: 6 | 7 | ```bash 8 | serverpod create . 9 | ``` 10 | 11 | Serverpod will now add the configuration files required for the full version. 12 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/08-upgrading/01-upgrade-from-mini.md: -------------------------------------------------------------------------------- 1 | # Upgrade from Mini to full 2 | 3 | If you have started with Serverpod Mini, you can upgrade to the full Serverpod version anytime. Before you upgrade, it's good practice to back up your project, as some configuration files can be overwritten if you have manually created them. 4 | 5 | To upgrade your project, change directory into your server, then run: 6 | 7 | ```bash 8 | serverpod create . 9 | ``` 10 | 11 | Serverpod will now add the configuration files required for the full version. 12 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/08-upgrading/01-upgrade-from-mini.md: -------------------------------------------------------------------------------- 1 | # Upgrade from Mini to full 2 | 3 | If you have started with Serverpod Mini, you can upgrade to the full Serverpod version anytime. Before you upgrade, it's good practice to back up your project, as some configuration files can be overwritten if you have manually created them. 4 | 5 | To upgrade your project, change directory into your server, then run: 6 | 7 | ```bash 8 | serverpod create . 9 | ``` 10 | 11 | Serverpod will now add the configuration files required for the full version. 12 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/08-upgrading/01-upgrade-from-mini.md: -------------------------------------------------------------------------------- 1 | # Upgrade from Mini to full 2 | 3 | If you have started with Serverpod Mini, you can upgrade to the full Serverpod version anytime. Before you upgrade, it's good practice to back up your project, as some configuration files can be overwritten if you have manually created them. 4 | 5 | To upgrade your project, change directory into your server, then run: 6 | 7 | ```bash 8 | serverpod create . 9 | ``` 10 | 11 | Serverpod will now add the configuration files required for the full version. 12 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/08-upgrading/01-upgrade-from-mini.md: -------------------------------------------------------------------------------- 1 | # Upgrade from Mini to full 2 | 3 | If you have started with Serverpod Mini, you can upgrade to the full Serverpod version anytime. Before you upgrade, it's good practice to back up your project, as some configuration files can be overwritten if you have manually created them. 4 | 5 | To upgrade your project, change directory into your server, then run: 6 | 7 | ```bash 8 | serverpod create . 9 | ``` 10 | 11 | Serverpod will now add the configuration files required for the full version. 12 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/08-upgrading/01-upgrade-from-mini.md: -------------------------------------------------------------------------------- 1 | # Upgrade from Mini to full 2 | 3 | If you have started with Serverpod Mini, you can upgrade to the full Serverpod version anytime. Before you upgrade, it's good practice to back up your project, as some configuration files can be overwritten if you have manually created them. 4 | 5 | To upgrade your project, change directory into your server, then run: 6 | 7 | ```bash 8 | serverpod create . 9 | ``` 10 | 11 | Serverpod will now add the configuration files required for the full version. 12 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/08-upgrading/01-upgrade-from-mini.md: -------------------------------------------------------------------------------- 1 | # Upgrade from Mini to full 2 | 3 | If you have started with Serverpod Mini, you can upgrade to the full Serverpod version anytime. Before you upgrade, it's good practice to back up your project, as some configuration files can be overwritten if you have manually created them. 4 | 5 | To upgrade your project, change directory into your server, then run: 6 | 7 | ```bash 8 | serverpod create . 9 | ``` 10 | 11 | Serverpod will now add the configuration files required for the full version. 12 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/08-upgrading/02-upgrade-from-mini.md: -------------------------------------------------------------------------------- 1 | # Upgrade from Mini to full 2 | 3 | If you have started with Serverpod Mini, you can upgrade to the full Serverpod version anytime. Before you upgrade, it's good practice to back up your project, as some configuration files can be overwritten if you have manually created them. 4 | 5 | To upgrade your project, change directory into your server, then run: 6 | 7 | ```bash 8 | serverpod create . 9 | ``` 10 | 11 | Serverpod will now add the configuration files required for the full version. 12 | -------------------------------------------------------------------------------- /versioned_docs/version-1.0.0/06-roadmap.md: -------------------------------------------------------------------------------- 1 | # Roadmap 2 | 3 | The complete Serverpod roadmap to version 1.0 is now up on Github. We are releasing features as soon as they become available and hope to have the final release ready in early fall 2022. 4 | 5 | [View the roadmap here.](https://github.com/serverpod/serverpod/projects/1) 6 | 7 | :::info 8 | 9 | If you want to suggest a new feature or report a bug, please [file an issue](https://github.com/serverpod/serverpod/issues) on Github. We're reviewing new issues and pull requests on a daily basis. 10 | 11 | ::: 12 | -------------------------------------------------------------------------------- /docs/07-deployments/06-community-supported-deployments.md: -------------------------------------------------------------------------------- 1 | # Community-supported deployments 2 | 3 | Serverpod can be deployed in multiple ways, and the community has developed tools to simplify the process. While these tools are not officially maintained by the Serverpod team, they can be a great starting point for getting your server up and running quickly. 4 | 5 | ## Virtual Private Server (VPS) 6 | 7 | [serverpod_vps](https://pub.dev/packages/serverpod_vps) provides a simple way to deploy Serverpod on a Virtual Private Server using Docker-Compose. The CLI creates all required files and the detailed step-by-step guide will help you get your server up and running in no time. 8 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/07-deployments/06-community-supported-deployments.md: -------------------------------------------------------------------------------- 1 | # Community-supported deployments 2 | 3 | Serverpod can be deployed in multiple ways, and the community has developed tools to simplify the process. While these tools are not officially maintained by the Serverpod team, they can be a great starting point for getting your server up and running quickly. 4 | 5 | ## Virtual Private Server (VPS) 6 | 7 | [serverpod_vps](https://pub.dev/packages/serverpod_vps) provides a simple way to deploy Serverpod on a Virtual Private Server using Docker-Compose. The CLI creates all required files and the detailed step-by-step guide will help you get your server up and running in no time. 8 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/07-deployments/06-community-supported-deployments.md: -------------------------------------------------------------------------------- 1 | # Community-supported deployments 2 | 3 | Serverpod can be deployed in multiple ways, and the community has developed tools to simplify the process. While these tools are not officially maintained by the Serverpod team, they can be a great starting point for getting your server up and running quickly. 4 | 5 | ## Virtual Private Server (VPS) 6 | 7 | [serverpod_vps](https://pub.dev/packages/serverpod_vps) provides a simple way to deploy Serverpod on a Virtual Private Server using Docker-Compose. The CLI creates all required files and the detailed step-by-step guide will help you get your server up and running in no time. 8 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/07-deployments/06-community-supported-deployments.md: -------------------------------------------------------------------------------- 1 | # Community-supported deployments 2 | 3 | Serverpod can be deployed in multiple ways, and the community has developed tools to simplify the process. While these tools are not officially maintained by the Serverpod team, they can be a great starting point for getting your server up and running quickly. 4 | 5 | ## Virtual Private Server (VPS) 6 | 7 | [serverpod_vps](https://pub.dev/packages/serverpod_vps) provides a simple way to deploy Serverpod on a Virtual Private Server using Docker-Compose. The CLI creates all required files and the detailed step-by-step guide will help you get your server up and running in no time. 8 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/07-deployments/06-community-supported-deployments.md: -------------------------------------------------------------------------------- 1 | # Community-supported deployments 2 | 3 | Serverpod can be deployed in multiple ways, and the community has developed tools to simplify the process. While these tools are not officially maintained by the Serverpod team, they can be a great starting point for getting your server up and running quickly. 4 | 5 | ## Virtual Private Server (VPS) 6 | 7 | [serverpod_vps](https://pub.dev/packages/serverpod_vps) provides a simple way to deploy Serverpod on a Virtual Private Server using Docker-Compose. The CLI creates all required files and the detailed step-by-step guide will help you get your server up and running in no time. 8 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/07-deployments/06-community-supported-deployments.md: -------------------------------------------------------------------------------- 1 | # Community-supported deployments 2 | 3 | Serverpod can be deployed in multiple ways, and the community has developed tools to simplify the process. While these tools are not officially maintained by the Serverpod team, they can be a great starting point for getting your server up and running quickly. 4 | 5 | ## Virtual Private Server (VPS) 6 | 7 | [serverpod_vps](https://pub.dev/packages/serverpod_vps) provides a simple way to deploy Serverpod on a Virtual Private Server using Docker-Compose. The CLI creates all required files and the detailed step-by-step guide will help you get your server up and running in no time. 8 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/07-deployments/06-community-supported-deployments.md: -------------------------------------------------------------------------------- 1 | # Community-supported deployments 2 | 3 | Serverpod can be deployed in multiple ways, and the community has developed tools to simplify the process. While these tools are not officially maintained by the Serverpod team, they can be a great starting point for getting your server up and running quickly. 4 | 5 | ## Virtual Private Server (VPS) 6 | 7 | [serverpod_vps](https://pub.dev/packages/serverpod_vps) provides a simple way to deploy Serverpod on a Virtual Private Server using Docker-Compose. The CLI creates all required files and the detailed step-by-step guide will help you get your server up and running in no time. 8 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/07-deployments/06-community-supported-deployments.md: -------------------------------------------------------------------------------- 1 | # Community-supported deployments 2 | 3 | Serverpod can be deployed in multiple ways, and the community has developed tools to simplify the process. While these tools are not officially maintained by the Serverpod team, they can be a great starting point for getting your server up and running quickly. 4 | 5 | ## Virtual Private Server (VPS) 6 | 7 | [serverpod_vps](https://pub.dev/packages/serverpod_vps) provides a simple way to deploy Serverpod on a Virtual Private Server using Docker-Compose. The CLI creates all required files and the detailed step-by-step guide will help you get your server up and running in no time. 8 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/07-deployments/06-community-supported-deployments.md: -------------------------------------------------------------------------------- 1 | # Community-supported deployments 2 | 3 | Serverpod can be deployed in multiple ways, and the community has developed tools to simplify the process. While these tools are not officially maintained by the Serverpod team, they can be a great starting point for getting your server up and running quickly. 4 | 5 | ## Virtual Private Server (VPS) 6 | 7 | [serverpod_vps](https://pub.dev/packages/serverpod_vps) provides a simple way to deploy Serverpod on a Virtual Private Server using Docker-Compose. The CLI creates all required files and the detailed step-by-step guide will help you get your server up and running in no time. 8 | -------------------------------------------------------------------------------- /docs/05-tutorials/02-tutorials/01-fundamentals.md: -------------------------------------------------------------------------------- 1 | # Backend fundamentals 2 | 3 | This video explains the fundamentals of backend development, how a database works, and how to get started with Serverpod. It is a great starting point for a Flutter developer new to working with backends and servers. 4 | 5 |
6 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/01-get-started/09-next-steps.md: -------------------------------------------------------------------------------- 1 | # Where to go next 2 | 3 | You should now have a basic understanding of how Serverpod works. The different topics are described in more detail in the _Concepts_ section of the documentation. If you are unfamiliar with server-side development, a good starting place for learning is to do the [Build your first app](../tutorials/first-app) tutorial. There are also many good video tutorials linked in the _Tutorials_ section. 4 | 5 | If you get stuck, never be afraid to ask questions in our [community on Github](https://github.com/serverpod/serverpod/discussions). The Serverpod team is very active there, and many questions are also answered by other developers in the community. 6 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/01-get-started/09-next-steps.md: -------------------------------------------------------------------------------- 1 | # Where to go next 2 | 3 | You should now have a basic understanding of how Serverpod works. The different topics are described in more detail in the _Concepts_ section of the documentation. If you are unfamiliar with server-side development, a good starting place for learning is to do the [Build your first app](../tutorials/first-app) tutorial. There are also many good video tutorials linked in the _Tutorials_ section. 4 | 5 | If you get stuck, never be afraid to ask questions in our [community on Github](https://github.com/serverpod/serverpod/discussions). The Serverpod team is very active there, and many questions are also answered by other developers in the community. 6 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/05-tutorials/02-tutorials/01-fundamentals.md: -------------------------------------------------------------------------------- 1 | # Backend fundamentals 2 | 3 | This video explains the fundamentals of backend development, how a database works, and how to get started with Serverpod. It is a great starting point for a Flutter developer new to working with backends and servers. 4 | 5 |
6 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/05-tutorials/02-tutorials/01-fundamentals.md: -------------------------------------------------------------------------------- 1 | # Backend fundamentals 2 | 3 | This video explains the fundamentals of backend development, how a database works, and how to get started with Serverpod. It is a great starting point for a Flutter developer new to working with backends and servers. 4 | 5 |
6 | 7 | -------------------------------------------------------------------------------- /docs/09-tools/02-lsp.md: -------------------------------------------------------------------------------- 1 | # LSP server 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/09-lsp.md: -------------------------------------------------------------------------------- 1 | # Serverpod LSP 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/09-tools/02-lsp.md: -------------------------------------------------------------------------------- 1 | # LSP server 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/09-tools/02-lsp.md: -------------------------------------------------------------------------------- 1 | # LSP server 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/09-tools/02-lsp.md: -------------------------------------------------------------------------------- 1 | # LSP server 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/09-tools/02-lsp.md: -------------------------------------------------------------------------------- 1 | # LSP server 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/09-tools/02-lsp.md: -------------------------------------------------------------------------------- 1 | # LSP server 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/09-tools/02-lsp.md: -------------------------------------------------------------------------------- 1 | # LSP server 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/09-tools/02-lsp.md: -------------------------------------------------------------------------------- 1 | # LSP server 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/09-tools/02-lsp.md: -------------------------------------------------------------------------------- 1 | # LSP server 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/09-tools/02-lsp.md: -------------------------------------------------------------------------------- 1 | # LSP server 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/09-tools/02-lsp.md: -------------------------------------------------------------------------------- 1 | # LSP server 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/07-tools/03-lsp.md: -------------------------------------------------------------------------------- 1 | # Serverpod LSP 2 | 3 | The [Language Server Protocol (LSP)](https://microsoft.github.io/language-server-protocol/) is a standardized protocol designed to provide development environments with language-specific functionalities. In the context of Serverpod, the LSP server specifically offers diagnostics for YAML protocol files, aiding developers in identifying and resolving potential issues within these files. 4 | 5 | To start the Serverpod LSP server, use the following command: 6 | 7 | ```bash 8 | $ serverpod language-server 9 | ``` 10 | 11 | :::info 12 | If you use [VS Code](https://code.visualstudio.com/) you can instead use the [Serverpod extension](https://marketplace.visualstudio.com/items?itemName=serverpod.serverpod). 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/03-tutorials/03-code-example.md: -------------------------------------------------------------------------------- 1 | # Code examples 2 | 3 | Looking at examples can be a great way to learn. Here we collect samples created by the Serverpod team and the community. 4 | 5 | - __[Notes app](https://github.com/serverpod/notes)__: A simple note-taking app showcasing how to create and interact with endpoints and the database. 6 | - __[Pixorama](https://pixorama.live)__: A multi-user drawing experience. Showcases Serverpod's real-time capabilities and is less than one page of code. 7 | - __[Auth module](https://github.com/serverpod/serverpod/tree/main/examples/auth_example)__: Shows how to use the auth module and authenticate with different providers. 8 | - __[Chat module](https://github.com/serverpod/serverpod/tree/main/examples/chat)__: Shows how to use the chat module to do a real-time chat. -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/03-tutorials/03-code-example.md: -------------------------------------------------------------------------------- 1 | # Code examples 2 | 3 | Looking at examples can be a great way to learn. Here we collect samples created by the Serverpod team and the community. 4 | 5 | - __[Notes app](https://github.com/serverpod/notes)__: A simple note-taking app showcasing how to create and interact with endpoints and the database. 6 | - __[Pixorama](https://pixorama.live)__: A multi-user drawing experience. Showcases Serverpod's real-time capabilities and is less than one page of code. 7 | - __[Auth module](https://github.com/serverpod/serverpod/tree/main/examples/auth_example)__: Shows how to use the auth module and authenticate with different providers. 8 | - __[Chat module](https://github.com/serverpod/serverpod/tree/main/examples/chat)__: Shows how to use the chat module to do a real-time chat. -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/03-tutorials/03-code-example.md: -------------------------------------------------------------------------------- 1 | # Code examples 2 | 3 | Looking at examples can be a great way to learn. Here we collect samples created by the Serverpod team and the community. 4 | 5 | - __[Notes app](https://github.com/serverpod/notes)__: A simple note-taking app showcasing how to create and interact with endpoints and the database. 6 | - __[Pixorama](https://pixorama.live)__: A multi-user drawing experience. Showcases Serverpod's real-time capabilities and is less than one page of code. 7 | - __[Auth module](https://github.com/serverpod/serverpod/tree/main/examples/auth_example)__: Shows how to use the auth module and authenticate with different providers. 8 | - __[Chat module](https://github.com/serverpod/serverpod/tree/main/examples/chat)__: Shows how to use the chat module to do a real-time chat. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/05-tutorials/03-code-example.md: -------------------------------------------------------------------------------- 1 | # Code examples 2 | 3 | Looking at examples can be a great way to learn. Here we collect samples created by the Serverpod team and the community. 4 | 5 | - __[Notes app](https://github.com/serverpod/notes)__: A simple note-taking app showcasing how to create and interact with endpoints and the database. 6 | - __[Pixorama](https://pixorama.live)__: A multi-user drawing experience. Showcases Serverpod's real-time capabilities and is less than one page of code. 7 | - __[Auth module](https://github.com/serverpod/serverpod/tree/main/examples/auth_example)__: Shows how to use the auth module and authenticate with different providers. 8 | - __[Chat module](https://github.com/serverpod/serverpod/tree/main/examples/chat)__: Shows how to use the chat module to do a real-time chat. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/05-tutorials/03-code-example.md: -------------------------------------------------------------------------------- 1 | # Code examples 2 | 3 | Looking at examples can be a great way to learn. Here we collect samples created by the Serverpod team and the community. 4 | 5 | - __[Notes app](https://github.com/serverpod/notes)__: A simple note-taking app showcasing how to create and interact with endpoints and the database. 6 | - __[Pixorama](https://pixorama.live)__: A multi-user drawing experience. Showcases Serverpod's real-time capabilities and is less than one page of code. 7 | - __[Auth module](https://github.com/serverpod/serverpod/tree/main/examples/auth_example)__: Shows how to use the auth module and authenticate with different providers. 8 | - __[Chat module](https://github.com/serverpod/serverpod/tree/main/examples/chat)__: Shows how to use the chat module to do a real-time chat. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/05-tutorials/03-code-example.md: -------------------------------------------------------------------------------- 1 | # Code examples 2 | 3 | Looking at examples can be a great way to learn. Here we collect samples created by the Serverpod team and the community. 4 | 5 | - __[Notes app](https://github.com/serverpod/notes)__: A simple note-taking app showcasing how to create and interact with endpoints and the database. 6 | - __[Pixorama](https://pixorama.live)__: A multi-user drawing experience. Showcases Serverpod's real-time capabilities and is less than one page of code. 7 | - __[Auth module](https://github.com/serverpod/serverpod/tree/main/examples/auth_example)__: Shows how to use the auth module and authenticate with different providers. 8 | - __[Chat module](https://github.com/serverpod/serverpod/tree/main/examples/chat)__: Shows how to use the chat module to do a real-time chat. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/05-tutorials/03-code-example.md: -------------------------------------------------------------------------------- 1 | # Code examples 2 | 3 | Looking at examples can be a great way to learn. Here we collect samples created by the Serverpod team and the community. 4 | 5 | - __[Notes app](https://github.com/serverpod/notes)__: A simple note-taking app showcasing how to create and interact with endpoints and the database. 6 | - __[Pixorama](https://pixorama.live)__: A multi-user drawing experience. Showcases Serverpod's real-time capabilities and is less than one page of code. 7 | - __[Auth module](https://github.com/serverpod/serverpod/tree/main/examples/auth_example)__: Shows how to use the auth module and authenticate with different providers. 8 | - __[Chat module](https://github.com/serverpod/serverpod/tree/main/examples/chat)__: Shows how to use the chat module to do a real-time chat. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/05-tutorials/03-code-example.md: -------------------------------------------------------------------------------- 1 | # Code examples 2 | 3 | Looking at examples can be a great way to learn. Here we collect samples created by the Serverpod team and the community. 4 | 5 | - __[Notes app](https://github.com/serverpod/notes)__: A simple note-taking app showcasing how to create and interact with endpoints and the database. 6 | - __[Pixorama](https://pixorama.live)__: A multi-user drawing experience. Showcases Serverpod's real-time capabilities and is less than one page of code. 7 | - __[Auth module](https://github.com/serverpod/serverpod/tree/main/examples/auth_example)__: Shows how to use the auth module and authenticate with different providers. 8 | - __[Chat module](https://github.com/serverpod/serverpod/tree/main/examples/chat)__: Shows how to use the chat module to do a real-time chat. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/05-tutorials/03-code-example.md: -------------------------------------------------------------------------------- 1 | # Code examples 2 | 3 | Looking at examples can be a great way to learn. Here we collect samples created by the Serverpod team and the community. 4 | 5 | - __[Notes app](https://github.com/serverpod/notes)__: A simple note-taking app showcasing how to create and interact with endpoints and the database. 6 | - __[Pixorama](https://pixorama.live)__: A multi-user drawing experience. Showcases Serverpod's real-time capabilities and is less than one page of code. 7 | - __[Auth module](https://github.com/serverpod/serverpod/tree/main/examples/auth_example)__: Shows how to use the auth module and authenticate with different providers. 8 | - __[Chat module](https://github.com/serverpod/serverpod/tree/main/examples/chat)__: Shows how to use the chat module to do a real-time chat. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/05-tutorials/03-code-example.md: -------------------------------------------------------------------------------- 1 | # Code examples 2 | 3 | Looking at examples can be a great way to learn. Here we collect samples created by the Serverpod team and the community. 4 | 5 | - __[Notes app](https://github.com/serverpod/notes)__: A simple note-taking app showcasing how to create and interact with endpoints and the database. 6 | - __[Pixorama](https://pixorama.live)__: A multi-user drawing experience. Showcases Serverpod's real-time capabilities and is less than one page of code. 7 | - __[Auth module](https://github.com/serverpod/serverpod/tree/main/examples/auth_example)__: Shows how to use the auth module and authenticate with different providers. 8 | - __[Chat module](https://github.com/serverpod/serverpod/tree/main/examples/chat)__: Shows how to use the chat module to do a real-time chat. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/05-tutorials/03-code-example.md: -------------------------------------------------------------------------------- 1 | # Code examples 2 | 3 | Looking at examples can be a great way to learn. Here we collect samples created by the Serverpod team and the community. 4 | 5 | - __[Notes app](https://github.com/serverpod/notes)__: A simple note-taking app showcasing how to create and interact with endpoints and the database. 6 | - __[Pixorama](https://pixorama.live)__: A multi-user drawing experience. Showcases Serverpod's real-time capabilities and is less than one page of code. 7 | - __[Auth module](https://github.com/serverpod/serverpod/tree/main/examples/auth_example)__: Shows how to use the auth module and authenticate with different providers. 8 | - __[Chat module](https://github.com/serverpod/serverpod/tree/main/examples/chat)__: Shows how to use the chat module to do a real-time chat. 9 | -------------------------------------------------------------------------------- /blog/2021-08-26-welcome/index.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: welcome 3 | title: Welcome 4 | authors: [slorber, yangshun] 5 | tags: [facebook, hello, docusaurus] 6 | --- 7 | 8 | [Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog). 9 | 10 | Simply add Markdown files (or folders) to the `blog` directory. 11 | 12 | Regular blog authors can be added to `authors.yml`. 13 | 14 | The blog post date can be extracted from filenames, such as: 15 | 16 | - `2019-05-30-welcome.md` 17 | - `2019-05-30-welcome/index.md` 18 | 19 | A blog post folder can be convenient to co-locate blog post images: 20 | 21 | ![Docusaurus Plushie](./docusaurus-plushie-banner.jpeg) 22 | 23 | The blog supports tags as well! 24 | 25 | **And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config. 26 | -------------------------------------------------------------------------------- /.github/workflows/title-validation.yml: -------------------------------------------------------------------------------- 1 | # See https://github.com/amannn/action-semantic-pull-request 2 | name: 'PR Title is Conventional' 3 | 4 | on: 5 | pull_request_target: 6 | types: 7 | - opened 8 | - edited 9 | - synchronize 10 | 11 | jobs: 12 | main: 13 | name: Validate PR title 14 | runs-on: ubuntu-latest 15 | steps: 16 | - uses: amannn/action-semantic-pull-request@v5 17 | env: 18 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 19 | with: 20 | types: | 21 | build 22 | chore 23 | ci 24 | docs 25 | feat 26 | fix 27 | perf 28 | refactor 29 | revert 30 | style 31 | test 32 | subjectPattern: ^[A-Z].+$ 33 | subjectPatternError: | 34 | The subject of the PR must begin with an uppercase letter. 35 | -------------------------------------------------------------------------------- /docs/05-tutorials/02-tutorials/03-ai-and-rag.md: -------------------------------------------------------------------------------- 1 | # Integrating AI & RAG 2 | 3 | Are you curious about how best to include AI in your Flutter app? In this talk, we will explore how you can use Serverpod to stream content generated by Gemini to your Flutter app in real-time. We will also dive into calling the Gemini APIs from Dart and linking them to your custom knowledge database using retrieval-augmented generation (RAG) and a vector database. We build a practical example where you can chat with the Flutter and Serverpod documentation, pulling in data from official docs, issues, and discussions on GitHub. 4 | 5 |
6 | -------------------------------------------------------------------------------- /sidebars.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Creating a sidebar enables you to: 3 | - create an ordered group of docs 4 | - render a sidebar for each doc of that group 5 | - provide next/previous navigation 6 | 7 | The sidebars can be generated from the filesystem, or explicitly defined here. 8 | 9 | Create as many sidebars as you want. 10 | */ 11 | 12 | // @ts-check 13 | 14 | /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ 15 | const sidebars = { 16 | // By default, Docusaurus generates a sidebar from the docs folder structure 17 | tutorialSidebar: [ 18 | { type: 'autogenerated', dirName: '.' }, 19 | { 20 | type: 'link', 21 | label: '📝 Changelog', 22 | href: 'https://pub.dev/packages/serverpod/changelog', 23 | }, 24 | ], 25 | 26 | // But you can create a sidebar manually 27 | /* 28 | tutorialSidebar: [ 29 | { 30 | type: 'category', 31 | label: 'Tutorial', 32 | items: ['hello'], 33 | }, 34 | ], 35 | */ 36 | }; 37 | 38 | module.exports = sidebars; 39 | -------------------------------------------------------------------------------- /.github/workflows/test-build.yml: -------------------------------------------------------------------------------- 1 | name: Docusaurus build 2 | on: 3 | push: 4 | branches: 5 | - main 6 | pull_request: 7 | branches: 8 | - main 9 | jobs: 10 | markdown-lint: 11 | runs-on: ubuntu-latest 12 | 13 | steps: 14 | - name: Checkout repository 15 | uses: actions/checkout@v2 16 | 17 | - name: Run markdownlint 18 | uses: articulate/actions-markdownlint@v1 19 | with: 20 | config: .markdownlint.yaml 21 | files: './docs/**/*.md' 22 | 23 | test-build: 24 | name: Test build 25 | runs-on: ubuntu-latest 26 | steps: 27 | - uses: actions/checkout@v3 28 | - uses: actions/setup-node@v3 29 | with: 30 | node-version: 20 31 | cache: npm 32 | - name: Install dependencies 33 | run: npm ci 34 | - name: Build 35 | run: npm run build -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/05-tutorials/02-tutorials/03-ai-and-rag.md: -------------------------------------------------------------------------------- 1 | # Integrating AI & RAG 2 | 3 | Are you curious about how best to include AI in your Flutter app? In this talk, we will explore how you can use Serverpod to stream content generated by Gemini to your Flutter app in real-time. We will also dive into calling the Gemini APIs from Dart and linking them to your custom knowledge database using retrieval-augmented generation (RAG) and a vector database. We build a practical example where you can chat with the Flutter and Serverpod documentation, pulling in data from official docs, issues, and discussions on GitHub. 4 | 5 |
-------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/05-tutorials/02-tutorials/03-ai-and-rag.md: -------------------------------------------------------------------------------- 1 | # Integrating AI & RAG 2 | 3 | Are you curious about how best to include AI in your Flutter app? In this talk, we will explore how you can use Serverpod to stream content generated by Gemini to your Flutter app in real-time. We will also dive into calling the Gemini APIs from Dart and linking them to your custom knowledge database using retrieval-augmented generation (RAG) and a vector database. We build a practical example where you can chat with the Flutter and Serverpod documentation, pulling in data from official docs, issues, and discussions on GitHub. 4 | 5 |
6 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.0/06-insights.md: -------------------------------------------------------------------------------- 1 | # Serverpod Insights 2 | 3 | Serverpod has a companion app. It is currently available for Mac and Windows, but Linux is coming soon. The app has support for viewing your server's logs and health metrics, but we are adding many more features in version 1.2. You must use a version of the app that matches the version of Serverpod you use in your project, or not all features may work correctly. 4 | 5 | ![Serverpod Insights](https://serverpod.dev/assets/img/serverpod-screenshot.webp) 6 | 7 | ## Downloads 8 | 9 | | App version | MacOS | Windows | 10 | | :------------------------- | :-------------------------------------------------------------------- | :------------ | 11 | | Serverpod 1.1.0 (latest) | [Download](https://downloads.serverpod.dev/macos/Serverpod-1.1.0.zip) | [Download](https://downloads.serverpod.dev/windows/serverpod-1.1.0.zip) | 12 | | Serverpod 1.0.0 | [Download](https://serverpod.dev/insights/Serverpod-1.0.0.zip) | n/a | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/07-insights.md: -------------------------------------------------------------------------------- 1 | # Serverpod Insights 2 | 3 | Serverpod has a companion app. It is currently available for Mac and Windows, but Linux is coming soon. The app has support for viewing your server's logs and health metrics, but we are adding many more features in version 1.2. You must use a version of the app that matches the version of Serverpod you use in your project, or not all features may work correctly. 4 | 5 | ![Serverpod Insights](https://serverpod.dev/assets/img/serverpod-screenshot.webp) 6 | 7 | ## Downloads 8 | 9 | | App version | MacOS | Windows | 10 | | :------------------------- | :-------------------------------------------------------------------- | :------------ | 11 | | Serverpod 1.1.0 (latest) | [Download](https://downloads.serverpod.dev/macos/Serverpod-1.1.0.zip) | [Download](https://downloads.serverpod.dev/windows/serverpod-1.1.0.zip) | 12 | | Serverpod 1.0.0 | [Download](https://serverpod.dev/insights/Serverpod-1.0.0.zip) | n/a | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/04-providers/03-apple/02-configuration.md: -------------------------------------------------------------------------------- 1 | # Configuration 2 | 3 | This page covers configuration options for the Apple identity provider beyond the basic setup. 4 | 5 | 8 | 9 | ## Web Routes Configuration 10 | 11 | Apple Sign-In requires web routes for handling callbacks and notifications. These routes must be configured both on Apple's side and in your Serverpod server. 12 | 13 | The `revokedNotificationRoutePath` is the path that Apple will call when a user revokes their authorization. The `webAuthenticationCallbackRoutePath` is the path that Apple will call when a user completes the sign-in process. 14 | 15 | These routes are configured in the `pod.configureAppleIdpRoutes()` method: 16 | ```dart 17 | pod.configureAppleIdpRoutes( 18 | revokedNotificationRoutePath: '/hooks/apple-notification', 19 | webAuthenticationCallbackRoutePath: '/auth/callback', 20 | ); 21 | ``` 22 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/06-concepts/11-authentication/04-providers/03-apple/02-configuration.md: -------------------------------------------------------------------------------- 1 | # Configuration 2 | 3 | This page covers configuration options for the Apple identity provider beyond the basic setup. 4 | 5 | 8 | 9 | ## Web Routes Configuration 10 | 11 | Apple Sign-In requires web routes for handling callbacks and notifications. These routes must be configured both on Apple's side and in your Serverpod server. 12 | 13 | The `revokedNotificationRoutePath` is the path that Apple will call when a user revokes their authorization. The `webAuthenticationCallbackRoutePath` is the path that Apple will call when a user completes the sign-in process. 14 | 15 | These routes are configured in the `pod.configureAppleIdpRoutes()` method: 16 | ```dart 17 | pod.configureAppleIdpRoutes( 18 | revokedNotificationRoutePath: '/hooks/apple-notification', 19 | webAuthenticationCallbackRoutePath: '/auth/callback', 20 | ); 21 | ``` 22 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/05-concepts/15-backward-compatibility.md: -------------------------------------------------------------------------------- 1 | # Backward compatibility 2 | 3 | As your app evolves, features will be added or changed. However, your users may still use older versions of the app as not everyone will update to the latest version and automatic updates through the app stores take time. Therefore it may be essential to make updates to your server compatible with older app versions. 4 | 5 | Following a simple set of rules, your server will stay compatible with older app versions: 6 | 7 | 1. __Avoid changing parameter names in endpoint methods.__ In the REST API Serverpod generates, the parameters are passed by name. This means that changing the parameter names of the endpoint methods will break backward compatibility. 8 | 2. __Do not delete endpoint methods or change their signature.__ Instead, add new methods if you must pass another set of parameters. Technically, you can add new named parameters if they are not required, but creating a new method may still feel cleaner. 9 | 3. __Avoid changing or removing fields and types in the serialized classes.__ However, you are free to add new fields as long as they are nullable. 10 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/06-concepts/17-backward-compatibility.md: -------------------------------------------------------------------------------- 1 | # Backward compatibility 2 | 3 | As your app evolves, features will be added or changed. However, your users may still use older versions of the app as not everyone will update to the latest version and automatic updates through the app stores take time. Therefore it may be essential to make updates to your server compatible with older app versions. 4 | 5 | Following a simple set of rules, your server will stay compatible with older app versions: 6 | 7 | 1. __Avoid changing parameter names in endpoint methods.__ In the REST API Serverpod generates, the parameters are passed by name. This means that changing the parameter names of the endpoint methods will break backward compatibility. 8 | 2. __Do not delete endpoint methods or change their signature.__ Instead, add new methods if you must pass another set of parameters. Technically, you can add new named parameters if they are not required, but creating a new method may still feel cleaner. 9 | 3. __Avoid changing or removing fields and types in the serialized classes.__ However, you are free to add new fields as long as they are nullable. 10 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/06-concepts/17-backward-compatibility.md: -------------------------------------------------------------------------------- 1 | # Backward compatibility 2 | 3 | As your app evolves, features will be added or changed. However, your users may still use older versions of the app as not everyone will update to the latest version and automatic updates through the app stores take time. Therefore it may be essential to make updates to your server compatible with older app versions. 4 | 5 | Following a simple set of rules, your server will stay compatible with older app versions: 6 | 7 | 1. __Avoid changing parameter names in endpoint methods.__ In the REST API Serverpod generates, the parameters are passed by name. This means that changing the parameter names of the endpoint methods will break backward compatibility. 8 | 2. __Do not delete endpoint methods or change their signature.__ Instead, add new methods if you must pass another set of parameters. Technically, you can add new named parameters if they are not required, but creating a new method may still feel cleaner. 9 | 3. __Avoid changing or removing fields and types in the serialized classes.__ However, you are free to add new fields as long as they are nullable. 10 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/06-concepts/17-backward-compatibility.md: -------------------------------------------------------------------------------- 1 | # Backward compatibility 2 | 3 | As your app evolves, features will be added or changed. However, your users may still use older versions of the app as not everyone will update to the latest version and automatic updates through the app stores take time. Therefore it may be essential to make updates to your server compatible with older app versions. 4 | 5 | Following a simple set of rules, your server will stay compatible with older app versions: 6 | 7 | 1. __Avoid changing parameter names in endpoint methods.__ In the REST API Serverpod generates, the parameters are passed by name. This means that changing the parameter names of the endpoint methods will break backward compatibility. 8 | 2. __Do not delete endpoint methods or change their signature.__ Instead, add new methods if you must pass another set of parameters. Technically, you can add new named parameters if they are not required, but creating a new method may still feel cleaner. 9 | 3. __Avoid changing or removing fields and types in the serialized classes.__ However, you are free to add new fields as long as they are nullable. 10 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/06-concepts/17-backward-compatibility.md: -------------------------------------------------------------------------------- 1 | # Backward compatibility 2 | 3 | As your app evolves, features will be added or changed. However, your users may still use older versions of the app as not everyone will update to the latest version and automatic updates through the app stores take time. Therefore it may be essential to make updates to your server compatible with older app versions. 4 | 5 | Following a simple set of rules, your server will stay compatible with older app versions: 6 | 7 | 1. __Avoid changing parameter names in endpoint methods.__ In the REST API Serverpod generates, the parameters are passed by name. This means that changing the parameter names of the endpoint methods will break backward compatibility. 8 | 2. __Do not delete endpoint methods or change their signature.__ Instead, add new methods if you must pass another set of parameters. Technically, you can add new named parameters if they are not required, but creating a new method may still feel cleaner. 9 | 3. __Avoid changing or removing fields and types in the serialized classes.__ However, you are free to add new fields as long as they are nullable. 10 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/06-concepts/17-backward-compatibility.md: -------------------------------------------------------------------------------- 1 | # Backward compatibility 2 | 3 | As your app evolves, features will be added or changed. However, your users may still use older versions of the app as not everyone will update to the latest version and automatic updates through the app stores take time. Therefore it may be essential to make updates to your server compatible with older app versions. 4 | 5 | Following a simple set of rules, your server will stay compatible with older app versions: 6 | 7 | 1. __Avoid changing parameter names in endpoint methods.__ In the REST API Serverpod generates, the parameters are passed by name. This means that changing the parameter names of the endpoint methods will break backward compatibility. 8 | 2. __Do not delete endpoint methods or change their signature.__ Instead, add new methods if you must pass another set of parameters. Technically, you can add new named parameters if they are not required, but creating a new method may still feel cleaner. 9 | 3. __Avoid changing or removing fields and types in the serialized classes.__ However, you are free to add new fields as long as they are nullable. 10 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/04-support.md: -------------------------------------------------------------------------------- 1 | # Support & community 2 | 3 | If you get stuck, you can get support through our Github community. The authors of Serverpod are checking in pretty much every day and helping out as much as we can. 4 | 5 | __[Public discussion board](https://github.com/serverpod/serverpod/discussions)__ 6 | 7 | ## Reporting issues 8 | 9 | Serverpod is a work in progress, and there may be issues that we aren't aware of. If you run into something that doesn't seem to work the way you expect it to, please file an issue so that we can get it fixed as soon as possible. 10 | 11 | __[Serverpod issue tracker](https://github.com/serverpod/serverpod/issues)__ 12 | 13 | ## Stay up-to-date 14 | 15 | We set up a mailing list to keep you up-to-date with any news and updates around Serverpod. We send an email about once a month or when something significant happens. 16 | 17 | __[Join the email list](https://serverpod.news)__ 18 | 19 | ## Community updates 20 | 21 | We are continuously adding videos on Youtube, including announcements of major new features, tutorials, and tips. 22 | 23 | __[Follow our YouTube channel](https://www.youtube.com/@serverpod)__ -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/04-support.md: -------------------------------------------------------------------------------- 1 | # Support & community 2 | 3 | If you get stuck, you can get support through our Github community. The authors of Serverpod are checking in pretty much every day and helping out as much as we can. 4 | 5 | __[Public discussion board](https://github.com/serverpod/serverpod/discussions)__ 6 | 7 | ## Reporting issues 8 | 9 | Serverpod is a work in progress, and there may be issues that we aren't aware of. If you run into something that doesn't seem to work the way you expect it to, please file an issue so that we can get it fixed as soon as possible. 10 | 11 | __[Serverpod issue tracker](https://github.com/serverpod/serverpod/issues)__ 12 | 13 | ## Stay up-to-date 14 | 15 | We set up a mailing list to keep you up-to-date with any news and updates around Serverpod. We send an email about once a month or when something significant happens. 16 | 17 | __[Join the email list](https://serverpod.news)__ 18 | 19 | ## Community updates 20 | 21 | We are continuously adding videos on Youtube, including announcements of major new features, tutorials, and tips. 22 | 23 | __[Follow our YouTube channel](https://www.youtube.com/@serverpod)__ -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/04-support.md: -------------------------------------------------------------------------------- 1 | # Support & community 2 | 3 | If you get stuck, you can get support through our Github community. The authors of Serverpod are checking in pretty much every day and helping out as much as we can. 4 | 5 | __[Public discussion board](https://github.com/serverpod/serverpod/discussions)__ 6 | 7 | ## Reporting issues 8 | 9 | Serverpod is a work in progress, and there may be issues that we aren't aware of. If you run into something that doesn't seem to work the way you expect it to, please file an issue so that we can get it fixed as soon as possible. 10 | 11 | __[Serverpod issue tracker](https://github.com/serverpod/serverpod/issues)__ 12 | 13 | ## Stay up-to-date 14 | 15 | We set up a mailing list to keep you up-to-date with any news and updates around Serverpod. We send an email about once a month or when something significant happens. 16 | 17 | __[Join the email list](https://serverpod.news)__ 18 | 19 | ## Community updates 20 | 21 | We are continuously adding videos on Youtube, including announcements of major new features, tutorials, and tips. 22 | 23 | __[Follow our YouTube channel](https://www.youtube.com/@serverpod)__ -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/04-support.md: -------------------------------------------------------------------------------- 1 | # Support & community 2 | 3 | If you get stuck, you can get support through our Github community. The authors of Serverpod are checking in pretty much every day and helping out as much as we can. 4 | 5 | __[Public discussion board](https://github.com/serverpod/serverpod/discussions)__ 6 | 7 | ## Reporting issues 8 | 9 | Serverpod is a work in progress, and there may be issues that we aren't aware of. If you run into something that doesn't seem to work the way you expect it to, please file an issue so that we can get it fixed as soon as possible. 10 | 11 | __[Serverpod issue tracker](https://github.com/serverpod/serverpod/issues)__ 12 | 13 | ## Stay up-to-date 14 | 15 | We set up a mailing list to keep you up-to-date with any news and updates around Serverpod. We send an email about once a month or when something significant happens. 16 | 17 | __[Join the email list](https://serverpod.news)__ 18 | 19 | ## Community updates 20 | 21 | We are continuously adding videos on Youtube, including announcements of major new features, tutorials, and tips. 22 | 23 | __[Follow our YouTube channel](https://www.youtube.com/@serverpod)__ -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/04-support.md: -------------------------------------------------------------------------------- 1 | # Support & community 2 | 3 | If you get stuck, you can get support through our Github community. The authors of Serverpod are checking in pretty much every day and helping out as much as we can. 4 | 5 | __[Public discussion board](https://github.com/serverpod/serverpod/discussions)__ 6 | 7 | ## Reporting issues 8 | 9 | Serverpod is a work in progress, and there may be issues that we aren't aware of. If you run into something that doesn't seem to work the way you expect it to, please file an issue so that we can get it fixed as soon as possible. 10 | 11 | __[Serverpod issue tracker](https://github.com/serverpod/serverpod/issues)__ 12 | 13 | ## Stay up-to-date 14 | 15 | We set up a mailing list to keep you up-to-date with any news and updates around Serverpod. We send an email about once a month or when something significant happens. 16 | 17 | __[Join the email list](https://serverpod.news)__ 18 | 19 | ## Community updates 20 | 21 | We are continuously adding videos on Youtube, including announcements of major new features, tutorials, and tips. 22 | 23 | __[Follow our YouTube channel](https://www.youtube.com/@serverpod)__ -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/04-support.md: -------------------------------------------------------------------------------- 1 | # Support & community 2 | 3 | If you get stuck, you can get support through our Github community. The authors of Serverpod are checking in pretty much every day and helping out as much as we can. 4 | 5 | __[Public discussion board](https://github.com/serverpod/serverpod/discussions)__ 6 | 7 | ## Reporting issues 8 | 9 | Serverpod is a work in progress, and there may be issues that we aren't aware of. If you run into something that doesn't seem to work the way you expect it to, please file an issue so that we can get it fixed as soon as possible. 10 | 11 | __[Serverpod issue tracker](https://github.com/serverpod/serverpod/issues)__ 12 | 13 | ## Stay up-to-date 14 | 15 | We set up a mailing list to keep you up-to-date with any news and updates around Serverpod. We send an email about once a month or when something significant happens. 16 | 17 | __[Join the email list](https://serverpod.news)__ 18 | 19 | ## Community updates 20 | 21 | We are continuously adding videos on Youtube, including announcements of major new features, tutorials, and tips. 22 | 23 | __[Follow our YouTube channel](https://www.youtube.com/@serverpod)__ -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/04-support.md: -------------------------------------------------------------------------------- 1 | # Support & community 2 | 3 | If you get stuck, you can get support through our Github community. The authors of Serverpod are checking in pretty much every day and helping out as much as we can. 4 | 5 | __[Public discussion board](https://github.com/serverpod/serverpod/discussions)__ 6 | 7 | ## Reporting issues 8 | 9 | Serverpod is a work in progress, and there may be issues that we aren't aware of. If you run into something that doesn't seem to work the way you expect it to, please file an issue so that we can get it fixed as soon as possible. 10 | 11 | __[Serverpod issue tracker](https://github.com/serverpod/serverpod/issues)__ 12 | 13 | ## Stay up-to-date 14 | 15 | We set up a mailing list to keep you up-to-date with any news and updates around Serverpod. We send an email about once a month or when something significant happens. 16 | 17 | __[Join the email list](https://serverpod.news)__ 18 | 19 | ## Community updates 20 | 21 | We are continuously adding videos on Youtube, including announcements of major new features, tutorials, and tips. 22 | 23 | __[Follow our YouTube channel](https://www.youtube.com/@serverpod)__ 24 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/04-support.md: -------------------------------------------------------------------------------- 1 | # Support & community 2 | 3 | If you get stuck, you can get support through our Github community. The authors of Serverpod are checking in pretty much every day and helping out as much as we can. 4 | 5 | __[Public discussion board](https://github.com/serverpod/serverpod/discussions)__ 6 | 7 | ## Reporting issues 8 | 9 | Serverpod is a work in progress, and there may be issues that we aren't aware of. If you run into something that doesn't seem to work the way you expect it to, please file an issue so that we can get it fixed as soon as possible. 10 | 11 | __[Serverpod issue tracker](https://github.com/serverpod/serverpod/issues)__ 12 | 13 | ## Stay up-to-date 14 | 15 | We set up a mailing list to keep you up-to-date with any news and updates around Serverpod. We send an email about once a month or when something significant happens. 16 | 17 | __[Join the email list](https://serverpod.news)__ 18 | 19 | ## Community updates 20 | 21 | We are continuously adding videos on Youtube, including announcements of major new features, tutorials, and tips. 22 | 23 | __[Follow our YouTube channel](https://www.youtube.com/@serverpod)__ 24 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/05-concepts/09-authentication/04-providers/05-firebase.md: -------------------------------------------------------------------------------- 1 | # Firebase 2 | 3 | Serverpod uses FlutterFire UI to handle authentication through Firebase. It allows you to add social sign-in types that Serverpod doesn't directly support. 4 | 5 | To add authentication with Firebase, you must first install and initialize the Firebase CLI tools and Flutter fire. Follow the instructions [here](https://firebase.google.com/docs/flutter/setup?platform=web) for your Flutter project. In the Firebase console, configure the different social sign-ins you plan to use. Then pass your provider configurations to either the signInWithFirebase method or the SignInWithFirebaseButton of the [serverpod_auth_firebase_flutter](https://pub.dev/packages/serverpod_auth_firebase_flutter) package. 6 | 7 | Server-side, you need to create a set of authentication keys in the [Firebase console](https://console.firebase.google.com/), download the JSON file, rename it to firebase_service_account_key.json and place it in the config folder. 8 | 9 | :::warning 10 | 11 | Serverpod automatically merges accounts that are using the same email addresses, so make sure only to allow sign-ins where the email has been verified. 12 | 13 | ::: 14 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/01-get-started/07-serializing-data.md: -------------------------------------------------------------------------------- 1 | # Serializing data 2 | 3 | Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. 4 | 5 | The structure for your serialized classes is defined in `.spy.yaml` files anywhere in the `lib` directory. Run `serverpod generate` in the home directory of the server to build the Dart code for the classes and make them accessible to both the server and client. 6 | 7 | Here is a simple example of a `.spy.yaml` file defining a serializable class: 8 | 9 | ```yaml 10 | class: Company 11 | fields: 12 | name: String 13 | foundedDate: DateTime? 14 | ``` 15 | 16 | Supported types are `bool`, `int`, `double`, `String`, `DateTime`, `ByteData`, and other serializable classes. You can also use `List`s and `Map`s of the supported types, just make sure to specify the types. Null safety is supported. The keys of `Map` must be non-nullable `String`s. Once your classes are generated, you can use them as parameters or return types to endpoint methods. 17 | 18 | :::tip 19 | 20 | You can also create custom serialized classes with tools such as Freezed. Learn more in the [Serialization](../concepts/serialization) section. 21 | 22 | ::: 23 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/01-get-started/07-serializing-data.md: -------------------------------------------------------------------------------- 1 | # Serializing data 2 | 3 | Serverpod makes it easy to generate serializable classes that can be passed between server and client or used to communicate with the database. 4 | 5 | The structure for your serialized classes is defined in `.spy.yaml` files anywhere in the `lib` directory. Run `serverpod generate` in the home directory of the server to build the Dart code for the classes and make them accessible to both the server and client. 6 | 7 | Here is a simple example of a `.spy.yaml` file defining a serializable class: 8 | 9 | ```yaml 10 | class: Company 11 | fields: 12 | name: String 13 | foundedDate: DateTime? 14 | ``` 15 | 16 | Supported types are `bool`, `int`, `double`, `String`, `DateTime`, `ByteData`, and other serializable classes. You can also use `List`s and `Map`s of the supported types, just make sure to specify the types. Null safety is supported. The keys of `Map` must be non-nullable `String`s. Once your classes are generated, you can use them as parameters or return types to endpoint methods. 17 | 18 | :::tip 19 | 20 | You can also create custom serialized classes with tools such as Freezed. Learn more in the [Serialization](../concepts/serialization) section. 21 | 22 | ::: 23 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/05-tutorials/01-academy.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_label: 🏫 Serverpod Academy 3 | --- 4 | 5 | # Serverpod Academy 6 | 7 | Welcome to Serverpod Academy. This is your gateway to mastering Serverpod through structured, hands-on learning experiences. 8 | 9 | ## Serverpod Ground Training 10 | 11 | Our flagship course, **Serverpod Ground Training**, is a comprehensive 4-hour class that takes you through all the fundamentals of building applications with Serverpod. In this course, you'll: 12 | 13 | - Learn the core concepts of Serverpod 14 | - Build a complete Flutter application with a Serverpod backend 15 | - Get hands-on experience with real-world development scenarios 16 | - Understand best practices for Serverpod development 17 | 18 | By the end of the course, you'll have built a fully functional application and gained practical knowledge that you can immediately apply to your own projects. Upon completion, you'll receive a certificate acknowledging your achievement. 19 | 20 | ## Future Courses 21 | 22 | We're committed to expanding our educational offerings. Stay tuned as we develop additional courses covering advanced topics and specialized use cases in Serverpod development. 23 | 24 | **[Join the Serverpod Academy](https://academy.serverpod.dev)** 25 | -------------------------------------------------------------------------------- /versioned_docs/version-1.0.0/04-concepts/05-logging.md: -------------------------------------------------------------------------------- 1 | # Logging 2 | Serverpod uses the database for storing logs; this makes it easy to search for errors, slow queries, or debug messages. To log custom messages during the execution of a session, use the `log` method of the `session` object. When the session is closed, either from successful execution or by failing from throwing an exception, the messages are written to the log. By default, session log entries are written for every completed session. 3 | 4 | ```dart 5 | session.log('This is working well'); 6 | ``` 7 | 8 | You can also pass exceptions and stack traces to the `log` method or set the logging level. 9 | 10 | ```dart 11 | session.log( 12 | 'Oops, something went wrong', 13 | level: LogLevel.warning, 14 | exception: e, 15 | stackTrace: stackTrace, 16 | ); 17 | ``` 18 | 19 | Log entries are stored in the following tables of the database: `serverpod_log` for text messages, `serverpod_query_log` for queries, and `serverpod_session_log` for completed sessions. Optionally, it's possible to pass a log level with the message to filter out messages depending on the server's runtime settings. 20 | 21 | :::info 22 | 23 | The Serverpod GUI is coming soon, making it easy to read, search, and configure the logs. 24 | 25 | ::: 26 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: install start version format lint clean 2 | 3 | # Default target 4 | all: install 5 | 6 | # Install dependencies 7 | install: 8 | npm install 9 | 10 | # Start development server 11 | start: 12 | npm start 13 | 14 | # Create a new version 15 | version: 16 | @if [ "$(VERSION)" = "" ]; then \ 17 | echo "Error: VERSION is required. Usage: make version VERSION=X.X.X"; \ 18 | exit 1; \ 19 | fi 20 | npm run docusaurus docs:version $(VERSION) 21 | 22 | # Format markdown files 23 | format: 24 | markdownlint './docs/**/*.md' --config .markdownlint.yaml --fix 25 | 26 | # Install markdownlint globally 27 | install-linter: 28 | npm install -g markdownlint-cli 29 | 30 | # Clean build artifacts 31 | clean: 32 | rm -rf build 33 | rm -rf .docusaurus 34 | rm -rf node_modules 35 | 36 | # Help command 37 | help: 38 | @echo "Available commands:" 39 | @echo " make install - Install dependencies" 40 | @echo " make start - Start development server" 41 | @echo " make version - Create new version (requires VERSION=X.X.X)" 42 | @echo " make format - Format markdown files" 43 | @echo " make install-linter - Install markdownlint globally" 44 | @echo " make clean - Clean build artifacts" 45 | @echo " make help - Show this help message" 46 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.0/04-concepts/07-logging.md: -------------------------------------------------------------------------------- 1 | # Logging 2 | Serverpod uses the database for storing logs; this makes it easy to search for errors, slow queries, or debug messages. To log custom messages during the execution of a session, use the `log` method of the `session` object. When the session is closed, either from successful execution or by failing from throwing an exception, the messages are written to the log. By default, session log entries are written for every completed session. 3 | 4 | ```dart 5 | session.log('This is working well'); 6 | ``` 7 | 8 | You can also pass exceptions and stack traces to the `log` method or set the logging level. 9 | 10 | ```dart 11 | session.log( 12 | 'Oops, something went wrong', 13 | level: LogLevel.warning, 14 | exception: e, 15 | stackTrace: stackTrace, 16 | ); 17 | ``` 18 | 19 | Log entries are stored in the following tables of the database: `serverpod_log` for text messages, `serverpod_query_log` for queries, and `serverpod_session_log` for completed sessions. Optionally, it's possible to pass a log level with the message to filter out messages depending on the server's runtime settings. 20 | 21 | :::info 22 | 23 | You can use the companion app **[Serverpod Insights](../insights)** to read, search, and configure the logs. 24 | 25 | ::: 26 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/05-concepts/07-logging.md: -------------------------------------------------------------------------------- 1 | # Logging 2 | Serverpod uses the database for storing logs; this makes it easy to search for errors, slow queries, or debug messages. To log custom messages during the execution of a session, use the `log` method of the `session` object. When the session is closed, either from successful execution or by failing from throwing an exception, the messages are written to the log. By default, session log entries are written for every completed session. 3 | 4 | ```dart 5 | session.log('This is working well'); 6 | ``` 7 | 8 | You can also pass exceptions and stack traces to the `log` method or set the logging level. 9 | 10 | ```dart 11 | session.log( 12 | 'Oops, something went wrong', 13 | level: LogLevel.warning, 14 | exception: e, 15 | stackTrace: stackTrace, 16 | ); 17 | ``` 18 | 19 | Log entries are stored in the following tables of the database: `serverpod_log` for text messages, `serverpod_query_log` for queries, and `serverpod_session_log` for completed sessions. Optionally, it's possible to pass a log level with the message to filter out messages depending on the server's runtime settings. 20 | 21 | :::info 22 | 23 | You can use the companion app **[Serverpod Insights](../insights)** to read, search, and configure the logs. 24 | 25 | ::: 26 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/05-concepts/08-logging.md: -------------------------------------------------------------------------------- 1 | # Logging 2 | Serverpod uses the database for storing logs; this makes it easy to search for errors, slow queries, or debug messages. To log custom messages during the execution of a session, use the `log` method of the `session` object. When the session is closed, either from successful execution or by failing from throwing an exception, the messages are written to the log. By default, session log entries are written for every completed session. 3 | 4 | ```dart 5 | session.log('This is working well'); 6 | ``` 7 | 8 | You can also pass exceptions and stack traces to the `log` method or set the logging level. 9 | 10 | ```dart 11 | session.log( 12 | 'Oops, something went wrong', 13 | level: LogLevel.warning, 14 | exception: e, 15 | stackTrace: stackTrace, 16 | ); 17 | ``` 18 | 19 | Log entries are stored in the following tables of the database: `serverpod_log` for text messages, `serverpod_query_log` for queries, and `serverpod_session_log` for completed sessions. Optionally, it's possible to pass a log level with the message to filter out messages depending on the server's runtime settings. 20 | 21 | :::info 22 | 23 | You can use the companion app **[Serverpod Insights](../insights)** to read, search, and configure the logs. 24 | 25 | ::: 26 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/05-concepts/08-logging.md: -------------------------------------------------------------------------------- 1 | # Logging 2 | 3 | Serverpod uses the database for storing logs; this makes it easy to search for errors, slow queries, or debug messages. To log custom messages during the execution of a session, use the `log` method of the `session` object. When the session is closed, either from successful execution or by failing from throwing an exception, the messages are written to the log. By default, session log entries are written for every completed session. 4 | 5 | ```dart 6 | session.log('This is working well'); 7 | ``` 8 | 9 | You can also pass exceptions and stack traces to the `log` method or set the logging level. 10 | 11 | ```dart 12 | session.log( 13 | 'Oops, something went wrong', 14 | level: LogLevel.warning, 15 | exception: e, 16 | stackTrace: stackTrace, 17 | ); 18 | ``` 19 | 20 | Log entries are stored in the following tables of the database: `serverpod_log` for text messages, `serverpod_query_log` for queries, and `serverpod_session_log` for completed sessions. Optionally, it's possible to pass a log level with the message to filter out messages depending on the server's runtime settings. 21 | 22 | :::info 23 | 24 | You can use the companion app **[Serverpod Insights](../tools/insights)** to read, search, and configure the logs. 25 | 26 | ::: 27 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/06-concepts/09-logging.md: -------------------------------------------------------------------------------- 1 | # Logging 2 | 3 | Serverpod uses the database for storing logs; this makes it easy to search for errors, slow queries, or debug messages. To log custom messages during the execution of a session, use the `log` method of the `session` object. When the session is closed, either from successful execution or by failing from throwing an exception, the messages are written to the log. By default, session log entries are written for every completed session. 4 | 5 | ```dart 6 | session.log('This is working well'); 7 | ``` 8 | 9 | You can also pass exceptions and stack traces to the `log` method or set the logging level. 10 | 11 | ```dart 12 | session.log( 13 | 'Oops, something went wrong', 14 | level: LogLevel.warning, 15 | exception: e, 16 | stackTrace: stackTrace, 17 | ); 18 | ``` 19 | 20 | Log entries are stored in the following tables of the database: `serverpod_log` for text messages, `serverpod_query_log` for queries, and `serverpod_session_log` for completed sessions. Optionally, it's possible to pass a log level with the message to filter out messages depending on the server's runtime settings. 21 | 22 | :::info 23 | 24 | You can use the companion app **[Serverpod Insights](../tools/insights)** to read, search, and configure the logs. 25 | 26 | ::: 27 | -------------------------------------------------------------------------------- /src/css/custom.css: -------------------------------------------------------------------------------- 1 | /** 2 | * Any CSS included here will be global. The classic template 3 | * bundles Infima by default. Infima is a CSS framework designed to 4 | * work well for content-centric websites. 5 | */ 6 | 7 | /* You can override the default Infima variables here. */ 8 | :root { 9 | --ifm-color-primary: #0950c3; 10 | --ifm-color-primary-dark: #0848af; 11 | --ifm-color-primary-darker: #0844a6; 12 | --ifm-color-primary-darkest: #063889; 13 | --ifm-color-primary-light: #0a58d6; 14 | --ifm-color-primary-lighter: #0a5ce0; 15 | --ifm-color-primary-lightest: #156af4; 16 | --ifm-code-font-size: 95%; 17 | } 18 | 19 | /* For readability concerns, you should choose a lighter palette in dark mode. */ 20 | [data-theme='dark'] { 21 | --ifm-color-primary: #99c0ff; 22 | --ifm-color-primary-dark: #70a7ff; 23 | --ifm-color-primary-darker: #5c9aff; 24 | --ifm-color-primary-darkest: #1f74ff; 25 | --ifm-color-primary-light: #c2d9ff; 26 | --ifm-color-primary-lighter: #d6e6ff; 27 | --ifm-color-primary-lightest: #ffffff;; 28 | } 29 | 30 | .docusaurus-highlight-code-line { 31 | background-color: rgba(0, 0, 0, 0.1); 32 | display: block; 33 | margin: 0 calc(-1 * var(--ifm-pre-padding)); 34 | padding: 0 var(--ifm-pre-padding); 35 | } 36 | 37 | [data-theme='dark'] .docusaurus-highlight-code-line { 38 | background-color: rgba(0, 0, 0, 0.3); 39 | } 40 | -------------------------------------------------------------------------------- /versioned_docs/version-1.0.0/04-concepts/12-backward-compatibility.md: -------------------------------------------------------------------------------- 1 | # Backward compatibility 2 | As your app evolves, features will be added or changed. However, your users may still use older versions of the app as not everyone will update to the latest version and automatic updates through the app stores take time. Therefore it may be essential to make updates to your server compatible with older app versions. 3 | 4 | Following a simple set of rules, your server will stay compatible with older app versions: 5 | 6 | 1. __Avoid changing parameter names in endpoint methods.__ In the REST API Serverpod generates, the parameters are passed by name. This means that changing the parameter names of the endpoint methods will break backward compatibility. 7 | 2. __Do not delete endpoint methods or change their signature.__ Instead, add new methods if you must pass another set of parameters. Technically, you can add new named parameters if they are not required, but creating a new method may still feel cleaner. 8 | 3. __Avoid changing or removing fields and types in the serialized classes.__ However, you are free to add new fields as long as they are nullable. 9 | 10 | :::info 11 | 12 | If you are changing serialized objects with bindings to a database table, you will need to update the database structure manually. Future versions of Serverpod will assist with database migrations. 13 | 14 | ::: -------------------------------------------------------------------------------- /versioned_docs/version-1.1.0/04-concepts/14-backward-compatibility.md: -------------------------------------------------------------------------------- 1 | # Backward compatibility 2 | As your app evolves, features will be added or changed. However, your users may still use older versions of the app as not everyone will update to the latest version and automatic updates through the app stores take time. Therefore it may be essential to make updates to your server compatible with older app versions. 3 | 4 | Following a simple set of rules, your server will stay compatible with older app versions: 5 | 6 | 1. __Avoid changing parameter names in endpoint methods.__ In the REST API Serverpod generates, the parameters are passed by name. This means that changing the parameter names of the endpoint methods will break backward compatibility. 7 | 2. __Do not delete endpoint methods or change their signature.__ Instead, add new methods if you must pass another set of parameters. Technically, you can add new named parameters if they are not required, but creating a new method may still feel cleaner. 8 | 3. __Avoid changing or removing fields and types in the serialized classes.__ However, you are free to add new fields as long as they are nullable. 9 | 10 | :::info 11 | 12 | If you are changing serialized objects with bindings to a database table, you will need to update the database structure manually. Future versions of Serverpod will assist with database migrations. 13 | 14 | ::: -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/05-concepts/14-backward-compatibility.md: -------------------------------------------------------------------------------- 1 | # Backward compatibility 2 | As your app evolves, features will be added or changed. However, your users may still use older versions of the app as not everyone will update to the latest version and automatic updates through the app stores take time. Therefore it may be essential to make updates to your server compatible with older app versions. 3 | 4 | Following a simple set of rules, your server will stay compatible with older app versions: 5 | 6 | 1. __Avoid changing parameter names in endpoint methods.__ In the REST API Serverpod generates, the parameters are passed by name. This means that changing the parameter names of the endpoint methods will break backward compatibility. 7 | 2. __Do not delete endpoint methods or change their signature.__ Instead, add new methods if you must pass another set of parameters. Technically, you can add new named parameters if they are not required, but creating a new method may still feel cleaner. 8 | 3. __Avoid changing or removing fields and types in the serialized classes.__ However, you are free to add new fields as long as they are nullable. 9 | 10 | :::info 11 | 12 | If you are changing serialized objects with bindings to a database table, you will need to update the database structure manually. Future versions of Serverpod will assist with database migrations. 13 | 14 | ::: -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/05-concepts/15-backward-compatibility.md: -------------------------------------------------------------------------------- 1 | # Backward compatibility 2 | As your app evolves, features will be added or changed. However, your users may still use older versions of the app as not everyone will update to the latest version and automatic updates through the app stores take time. Therefore it may be essential to make updates to your server compatible with older app versions. 3 | 4 | Following a simple set of rules, your server will stay compatible with older app versions: 5 | 6 | 1. __Avoid changing parameter names in endpoint methods.__ In the REST API Serverpod generates, the parameters are passed by name. This means that changing the parameter names of the endpoint methods will break backward compatibility. 7 | 2. __Do not delete endpoint methods or change their signature.__ Instead, add new methods if you must pass another set of parameters. Technically, you can add new named parameters if they are not required, but creating a new method may still feel cleaner. 8 | 3. __Avoid changing or removing fields and types in the serialized classes.__ However, you are free to add new fields as long as they are nullable. 9 | 10 | :::info 11 | 12 | If you are changing serialized objects with bindings to a database table, you will need to update the database structure manually. Future versions of Serverpod will assist with database migrations. 13 | 14 | ::: -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/05-concepts/06-database/08-transactions.md: -------------------------------------------------------------------------------- 1 | # Transactions 2 | 3 | The essential point of a database transaction is that it bundles multiple steps into a single, all-or-nothing operation. The intermediate states between the steps are not visible to other concurrent transactions, and if some failure occurs that prevents the transaction from completing, then none of the steps affect the database at all. 4 | 5 | Serverpod handles database transactions through the `session.db.transaction` method. The transaction takes a method that performs any database queries or other operations and optionally returns a value. 6 | 7 | Simply pass the transaction object to each database operation method to include them in the same atomic operation: 8 | 9 | ```dart 10 | var result = await session.db.transaction((transaction) async { 11 | // Do some database queries here. 12 | await Company.db.insertRow(session, company, transaction: transaction); 13 | await Employee.db.insertRow(session, employee, transaction: transaction); 14 | 15 | // Optionally return a value. 16 | return true; 17 | }); 18 | ``` 19 | 20 | In the example we insert a company and an employee in the same transaction. If any of the operations fail, the entire transaction will be rolled back and no changes will be made to the database. If the transaction is successful, the return value will be `true`. 21 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/06-concepts/06-database/08-transactions.md: -------------------------------------------------------------------------------- 1 | # Transactions 2 | 3 | The essential point of a database transaction is that it bundles multiple steps into a single, all-or-nothing operation. The intermediate states between the steps are not visible to other concurrent transactions, and if some failure occurs that prevents the transaction from completing, then none of the steps affect the database at all. 4 | 5 | Serverpod handles database transactions through the `session.db.transaction` method. The transaction takes a method that performs any database queries or other operations and optionally returns a value. 6 | 7 | Simply pass the transaction object to each database operation method to include them in the same atomic operation: 8 | 9 | ```dart 10 | var result = await session.db.transaction((transaction) async { 11 | // Do some database queries here. 12 | await Company.db.insertRow(session, company, transaction: transaction); 13 | await Employee.db.insertRow(session, employee, transaction: transaction); 14 | 15 | // Optionally return a value. 16 | return true; 17 | }); 18 | ``` 19 | 20 | In the example we insert a company and an employee in the same transaction. If any of the operations fail, the entire transaction will be rolled back and no changes will be made to the database. If the transaction is successful, the return value will be `true`. 21 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/06-concepts/06-database/08-transactions.md: -------------------------------------------------------------------------------- 1 | # Transactions 2 | 3 | The essential point of a database transaction is that it bundles multiple steps into a single, all-or-nothing operation. The intermediate states between the steps are not visible to other concurrent transactions, and if some failure occurs that prevents the transaction from completing, then none of the steps affect the database at all. 4 | 5 | Serverpod handles database transactions through the `session.db.transaction` method. The transaction takes a method that performs any database queries or other operations and optionally returns a value. 6 | 7 | Simply pass the transaction object to each database operation method to include them in the same atomic operation: 8 | 9 | ```dart 10 | var result = await session.db.transaction((transaction) async { 11 | // Do some database queries here. 12 | await Company.db.insertRow(session, company, transaction: transaction); 13 | await Employee.db.insertRow(session, employee, transaction: transaction); 14 | 15 | // Optionally return a value. 16 | return true; 17 | }); 18 | ``` 19 | 20 | In the example we insert a company and an employee in the same transaction. If any of the operations fail, the entire transaction will be rolled back and no changes will be made to the database. If the transaction is successful, the return value will be `true`. 21 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/01-get-started/01-overview.md: -------------------------------------------------------------------------------- 1 | # Get started 2 | 3 | The getting started guide will help you understand how a Serverpod project is structured, how to make calls to endpoints, and how to communicate with the database. 4 | 5 | We also prepared a video going over the basics of Serverpod and the technology its built upon. If you want to jump right in, you can skip the video and go straight to the [Serverpod Mini](get-started-with-mini) section or [create a full Serverpod project](creating-project). 6 | 7 |
8 | 9 | ## Quick Links 10 | 11 | - [Serverpod or Serverpod Mini?](serverpod-vs-mini) 12 | - [Creating a new Serverpod project](creating-project) 13 | - [Get started with Mini](get-started-with-mini) 14 | - [Server overview](server-overview) 15 | - [Working with endpoints](working-with-endpoints) 16 | - [Serializing data](serializing-data) 17 | - [Working with the database](working-with-database) 18 | - [Where to go next](next-steps) 19 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/01-get-started/01-overview.md: -------------------------------------------------------------------------------- 1 | # Get started 2 | 3 | The getting started guide will help you understand how a Serverpod project is structured, how to make calls to endpoints, and how to communicate with the database. 4 | 5 | We also prepared a video going over the basics of Serverpod and the technology its built upon. If you want to jump right in, you can skip the video and go straight to the [Serverpod Mini](get-started-with-mini) section or [create a full Serverpod project](creating-project). 6 | 7 |
8 | 9 | ## Quick Links 10 | 11 | - [Serverpod or Serverpod Mini?](serverpod-vs-mini) 12 | - [Creating a new Serverpod project](creating-project) 13 | - [Get started with Mini](get-started-with-mini) 14 | - [Server overview](server-overview) 15 | - [Working with endpoints](working-with-endpoints) 16 | - [Serializing data](serializing-data) 17 | - [Working with the database](working-with-database) 18 | - [Where to go next](next-steps) 19 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/05-concepts/06-database/08-transactions.md: -------------------------------------------------------------------------------- 1 | # Transactions 2 | 3 | The essential point of a database transaction is that it bundles multiple steps into a single, all-or-nothing operation. The intermediate states between the steps are not visible to other concurrent transactions, and if some failure occurs that prevents the transaction from completing, then none of the steps affect the database at all. 4 | 5 | Serverpod handles database transactions through the `session.dbNext.transaction` method. The transaction takes a method that performs any database queries or other operations and optionally returns a value. 6 | 7 | Simply pass the transaction object to each database operation method to include them in the same atomic operation: 8 | 9 | ```dart 10 | var result = await session.dbNext.transaction((transaction) async { 11 | // Do some database queries here. 12 | await Company.db.insertRow(session, company, transaction: transaction); 13 | await Employee.db.insertRow(session, employee, transaction: transaction); 14 | 15 | // Optionally return a value. 16 | return true; 17 | }); 18 | ``` 19 | 20 | In the example we insert a company and an employee in the same transaction. If any of the operations fail, the entire transaction will be rolled back and no changes will be made to the database. If the transaction is successful, the return value will be `true`. 21 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/01-get-started/06-working-with-endpoints.md: -------------------------------------------------------------------------------- 1 | # Working with endpoints 2 | 3 | Endpoints are the connection points to the server from the client. With Serverpod, you add methods to your endpoint, and your client code will be generated. For the code to be generated, you need to place your endpoint in the `lib/src/endpoints` directory of your server. Your endpoint should extend the `Endpoint` class. For methods to be generated, they need to return a typed `Future`, and its first parameter should be a `Session` object. The `Session` object holds information about the call being made and provides access to the database. 4 | 5 | ```dart 6 | import 'package:serverpod/serverpod.dart'; 7 | 8 | class ExampleEndpoint extends Endpoint { 9 | Future hello(Session session, String name) async { 10 | return 'Hello $name'; 11 | } 12 | } 13 | ``` 14 | 15 | The above code will create an endpoint called `example` (the Endpoint suffix will be removed) with the single `hello` method. To generate the client-side code run `serverpod generate` in the home directory of the server. 16 | 17 | On the client side, you can now invoke the method by calling: 18 | 19 | ```dart 20 | var result = await client.example.hello('World'); 21 | ``` 22 | 23 | :::tip 24 | 25 | To learn more about endpoints, see the [Working with endpoints](../concepts/working-with-endpoints) section. 26 | 27 | ::: 28 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/01-get-started/06-working-with-endpoints.md: -------------------------------------------------------------------------------- 1 | # Working with endpoints 2 | 3 | Endpoints are the connection points to the server from the client. With Serverpod, you add methods to your endpoint, and your client code will be generated. For the code to be generated, you need to place your endpoint in the `lib/src/endpoints` directory of your server. Your endpoint should extend the `Endpoint` class. For methods to be generated, they need to return a typed `Future`, and its first parameter should be a `Session` object. The `Session` object holds information about the call being made and provides access to the database. 4 | 5 | ```dart 6 | import 'package:serverpod/serverpod.dart'; 7 | 8 | class ExampleEndpoint extends Endpoint { 9 | Future hello(Session session, String name) async { 10 | return 'Hello $name'; 11 | } 12 | } 13 | ``` 14 | 15 | The above code will create an endpoint called `example` (the Endpoint suffix will be removed) with the single `hello` method. To generate the client-side code run `serverpod generate` in the home directory of the server. 16 | 17 | On the client side, you can now invoke the method by calling: 18 | 19 | ```dart 20 | var result = await client.example.hello('World'); 21 | ``` 22 | 23 | :::tip 24 | 25 | To learn more about endpoints, see the [Working with endpoints](../concepts/working-with-endpoints) section. 26 | 27 | ::: 28 | -------------------------------------------------------------------------------- /docs/04-support.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_label: 💬 Support & community 3 | --- 4 | 5 | # Support & community 6 | 7 | Welcome to the Serverpod community! We offer several ways to get help, stay informed, and connect with other developers. 8 | 9 | If you get stuck, you can get support through our GitHub community. The authors of Serverpod are checking in pretty much every day and helping out as much as we can. 10 | 11 | __[Public discussion board](https://github.com/serverpod/serverpod/discussions)__ 12 | 13 | ## Reporting issues 14 | 15 | Serverpod is a work in progress, and there may be issues that we aren't aware of. If you run into something that doesn't seem to work the way you expect it to, please file an issue so that we can get it fixed as soon as possible. 16 | 17 | __[Serverpod issue tracker](https://github.com/serverpod/serverpod/issues)__ 18 | 19 | ## Stay up-to-date 20 | 21 | We set up a mailing list to keep you up-to-date with any news and updates around Serverpod. We send an email about once a month or when something significant happens. 22 | 23 | __[Join the email list](https://serverpod.news)__ 24 | 25 | ## Community updates 26 | 27 | Stay connected with our video content! We regularly publish videos on YouTube covering: 28 | 29 | - Announcements of major new features 30 | - Step-by-step tutorials 31 | - Tips and best practices 32 | - Community highlights 33 | 34 | __[Follow our YouTube channel](https://www.youtube.com/@serverpod)__ 35 | -------------------------------------------------------------------------------- /docs/05-tutorials/01-academy.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_label: 🏫 Serverpod Academy 3 | --- 4 | 5 | # Serverpod Academy 6 | 7 | Welcome to Serverpod Academy. This is your gateway to mastering Serverpod through structured, hands-on learning experiences. 8 | 9 | :::warning 10 | 11 | We are updating Serverpod Academy for Serverpod 3. The academy currently covers version 2, and there have been some changes to how authentication is implemented. 12 | 13 | ::: 14 | 15 | ## Serverpod Ground Training 16 | 17 | Our flagship course, **Serverpod Ground Training**, is a comprehensive 4-hour class that takes you through all the fundamentals of building applications with Serverpod. In this course, you'll: 18 | 19 | - Learn the core concepts of Serverpod 20 | - Build a complete Flutter application with a Serverpod backend 21 | - Get hands-on experience with real-world development scenarios 22 | - Understand best practices for Serverpod development 23 | 24 | By the end of the course, you'll have built a fully functional application and gained practical knowledge that you can immediately apply to your own projects. Upon completion, you'll receive a certificate acknowledging your achievement. 25 | 26 | ## Future Courses 27 | 28 | We're committed to expanding our educational offerings. Stay tuned as we develop additional courses covering advanced topics and specialized use cases in Serverpod development. 29 | 30 | **[Join the Serverpod Academy](https://academy.serverpod.dev)** 31 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/01-get-started/02-serverpod-vs-mini.md: -------------------------------------------------------------------------------- 1 | # Serverpod or Serverpod Mini? 2 | 3 | Serverpod Mini is a lightweight version of Serverpod that is perfect for small projects or when you want to try out Serverpod without setting up a Postgres database. If you start with Mini, you can upgrade to the full version of Serverpod anytime. 4 | 5 | **[Get started with Mini](get-started-with-mini)** 6 | 7 |
8 | __Serverpod vs Serverpod Mini comparison__ 9 |

10 | 11 | | Feature | Serverpod | Serverpod Mini | 12 | | --------------------- | :-------: | :------------: | 13 | | Remote method calls | ✅ | ✅ | 14 | | Generated data models | ✅ | ✅ | 15 | | Streaming data | ✅ | ✅ | 16 | | Custom auth | ✅ | ✅ | 17 | | Pre-built auth | ✅ | | 18 | | Postgres database ORM | ✅ | | 19 | | Task scheduling | ✅ | | 20 | | Basic logging | ✅ | ✅ | 21 | | Serverpod Insights | ✅ | | 22 | | Caching | ✅ | ✅ | 23 | | File uploads | ✅ | | 24 | | Health checks | ✅ | | 25 | | Relic web server | ✅ | | 26 | | Easy deployment | ✅ | ✅ | 27 | 28 |

29 |
30 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/01-get-started/02-serverpod-vs-mini.md: -------------------------------------------------------------------------------- 1 | # Serverpod or Serverpod Mini? 2 | 3 | Serverpod Mini is a lightweight version of Serverpod that is perfect for small projects or when you want to try out Serverpod without setting up a Postgres database. If you start with Mini, you can upgrade to the full version of Serverpod anytime. 4 | 5 | **[Get started with Mini](get-started-with-mini)** 6 | 7 |
8 | __Serverpod vs Serverpod Mini comparison__ 9 |

10 | 11 | | Feature | Serverpod | Serverpod Mini | 12 | | --------------------- | :-------: | :------------: | 13 | | Remote method calls | ✅ | ✅ | 14 | | Generated data models | ✅ | ✅ | 15 | | Streaming data | ✅ | ✅ | 16 | | Custom auth | ✅ | ✅ | 17 | | Pre-built auth | ✅ | | 18 | | Postgres database ORM | ✅ | | 19 | | Task scheduling | ✅ | | 20 | | Basic logging | ✅ | ✅ | 21 | | Serverpod Insights | ✅ | | 22 | | Caching | ✅ | ✅ | 23 | | File uploads | ✅ | | 24 | | Health checks | ✅ | | 25 | | Relic web server | ✅ | | 26 | | Easy deployment | ✅ | ✅ | 27 | 28 |

29 |
30 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/04-support.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_label: 💬 Support & community 3 | --- 4 | 5 | # Support & community 6 | 7 | Welcome to the Serverpod community! We offer several ways to get help, stay informed, and connect with other developers. 8 | 9 | If you get stuck, you can get support through our GitHub community. The authors of Serverpod are checking in pretty much every day and helping out as much as we can. 10 | 11 | __[Public discussion board](https://github.com/serverpod/serverpod/discussions)__ 12 | 13 | ## Reporting issues 14 | 15 | Serverpod is a work in progress, and there may be issues that we aren't aware of. If you run into something that doesn't seem to work the way you expect it to, please file an issue so that we can get it fixed as soon as possible. 16 | 17 | __[Serverpod issue tracker](https://github.com/serverpod/serverpod/issues)__ 18 | 19 | ## Stay up-to-date 20 | 21 | We set up a mailing list to keep you up-to-date with any news and updates around Serverpod. We send an email about once a month or when something significant happens. 22 | 23 | __[Join the email list](https://serverpod.news)__ 24 | 25 | ## Community updates 26 | 27 | Stay connected with our video content! We regularly publish videos on YouTube covering: 28 | - Announcements of major new features 29 | - Step-by-step tutorials 30 | - Tips and best practices 31 | - Community highlights 32 | 33 | __[Follow our YouTube channel](https://www.youtube.com/@serverpod)__ 34 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/04-support.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_label: 💬 Support & community 3 | --- 4 | 5 | # Support & community 6 | 7 | Welcome to the Serverpod community! We offer several ways to get help, stay informed, and connect with other developers. 8 | 9 | If you get stuck, you can get support through our GitHub community. The authors of Serverpod are checking in pretty much every day and helping out as much as we can. 10 | 11 | __[Public discussion board](https://github.com/serverpod/serverpod/discussions)__ 12 | 13 | ## Reporting issues 14 | 15 | Serverpod is a work in progress, and there may be issues that we aren't aware of. If you run into something that doesn't seem to work the way you expect it to, please file an issue so that we can get it fixed as soon as possible. 16 | 17 | __[Serverpod issue tracker](https://github.com/serverpod/serverpod/issues)__ 18 | 19 | ## Stay up-to-date 20 | 21 | We set up a mailing list to keep you up-to-date with any news and updates around Serverpod. We send an email about once a month or when something significant happens. 22 | 23 | __[Join the email list](https://serverpod.news)__ 24 | 25 | ## Community updates 26 | 27 | Stay connected with our video content! We regularly publish videos on YouTube covering: 28 | 29 | - Announcements of major new features 30 | - Step-by-step tutorials 31 | - Tips and best practices 32 | - Community highlights 33 | 34 | __[Follow our YouTube channel](https://www.youtube.com/@serverpod)__ 35 | -------------------------------------------------------------------------------- /docs/05-tutorials/03-guides/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/05-tutorials/01-academy.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_label: 🏫 Serverpod Academy 3 | --- 4 | 5 | # Serverpod Academy 6 | 7 | Welcome to Serverpod Academy. This is your gateway to mastering Serverpod through structured, hands-on learning experiences. 8 | 9 | :::warning 10 | 11 | We are updating Serverpod Academy for Serverpod 3. The academy currently covers version 2, and there have been some changes to how authentication is implemented. 12 | 13 | ::: 14 | 15 | ## Serverpod Ground Training 16 | 17 | Our flagship course, **Serverpod Ground Training**, is a comprehensive 4-hour class that takes you through all the fundamentals of building applications with Serverpod. In this course, you'll: 18 | 19 | - Learn the core concepts of Serverpod 20 | - Build a complete Flutter application with a Serverpod backend 21 | - Get hands-on experience with real-world development scenarios 22 | - Understand best practices for Serverpod development 23 | 24 | By the end of the course, you'll have built a fully functional application and gained practical knowledge that you can immediately apply to your own projects. Upon completion, you'll receive a certificate acknowledging your achievement. 25 | 26 | ## Future Courses 27 | 28 | We're committed to expanding our educational offerings. Stay tuned as we develop additional courses covering advanced topics and specialized use cases in Serverpod development. 29 | 30 | **[Join the Serverpod Academy](https://academy.serverpod.dev)** 31 | -------------------------------------------------------------------------------- /versioned_docs/version-1.1.1/03-tutorials/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-1.2.0/03-tutorials/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.0.0/03-tutorials/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.1.0/05-tutorials/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.2.0/05-tutorials/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/05-tutorials/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/05-tutorials/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/05-tutorials/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/05-tutorials/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/05-tutorials/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/05-tutorials/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.9.0/05-tutorials/03-guides/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-3.0.0/05-tutorials/03-guides/04-authentication.md: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Our comprehensive Authentication series is designed to guide you seamlessly through the process of setting up and utilizing the auth module within Serverpod. Each part of this series is tailored to introduce and explain different aspects of authentication, aiming to make it a straightforward process, regardless of your experience level. We recommend starting with the first one to complete the setup of the auth module before moving on to specific providers. 4 | 5 | - __[Setup & Email and Password](https://medium.com/serverpod/getting-started-with-serverpod-authentication-part-1-72c25280e6e9)__: This part covers the integration of the auth module into your project, and lays out the steps to establish Email and Password authentication. 6 | - __[Google Sign in](https://medium.com/serverpod/integrating-google-sign-in-with-serverpod-authentication-part-2-6fade3099baf)__: We walk you through setting up Google Sign in as part of your authentication scheme using the auth module. 7 | - __[Google API](https://medium.com/serverpod/working-with-the-google-api-in-serverpod-authentication-part-2-5-bbb077ec74d4)__: We dive deeper into the Google API, teaching you how to leverage it for enhanced functionalities and guiding users to grant access to their resources. 8 | - __[Sign in with Apple](https://medium.com/serverpod/integrating-apple-sign-in-with-serverpod-authentication-part-3-f5a49d006800)__: Add Sign in with Apple to your app. 9 | -------------------------------------------------------------------------------- /versioned_docs/version-2.3.0/10-contribute.md: -------------------------------------------------------------------------------- 1 | # Roadmap & contributions 2 | 3 | Serverpod is built by the community, for the community. We believe the best software comes from collaboration, where many people contribute their ideas and skills. That's why we strive to make contributing as easy as possible and share our plans for future development in our public roadmap. 4 | 5 |
6 | 7 | ## Roadmap 8 | 9 | Serverpod's [roadmap](https://github.com/orgs/serverpod/projects/4) outlines the features and improvements that are planned for the project. The roadmap is subject to change, but provides a good overview over work in progress and what is planned for the future. 10 | 11 | If you are considering contributing code to Serverpod, please check the roadmap to see if your contribution aligns with the project's goals. 12 | 13 | ## Contributions 14 | 15 | There are many ways to contribute to Serverpod’s development. If you're interested, check out our [contribution guidelines](https://github.com/serverpod/serverpod/blob/main/CONTRIBUTING.md) to learn how you can contribute code, report bugs, and suggest improvements. 16 | -------------------------------------------------------------------------------- /versioned_docs/version-2.4.0/10-contribute.md: -------------------------------------------------------------------------------- 1 | # Roadmap & contributions 2 | 3 | Serverpod is built by the community, for the community. We believe the best software comes from collaboration, where many people contribute their ideas and skills. That's why we strive to make contributing as easy as possible and share our plans for future development in our public roadmap. 4 | 5 |
6 | 7 | ## Roadmap 8 | 9 | Serverpod's [roadmap](https://github.com/orgs/serverpod/projects/4) outlines the features and improvements that are planned for the project. The roadmap is subject to change, but provides a good overview over work in progress and what is planned for the future. 10 | 11 | If you are considering contributing code to Serverpod, please check the roadmap to see if your contribution aligns with the project's goals. 12 | 13 | ## Contributions 14 | 15 | There are many ways to contribute to Serverpod’s development. If you're interested, check out our [contribution guidelines](https://github.com/serverpod/serverpod/blob/main/CONTRIBUTING.md) to learn how you can contribute code, report bugs, and suggest improvements. 16 | -------------------------------------------------------------------------------- /versioned_docs/version-2.5.0/10-contribute.md: -------------------------------------------------------------------------------- 1 | # Roadmap & contributions 2 | 3 | Serverpod is built by the community, for the community. We believe the best software comes from collaboration, where many people contribute their ideas and skills. That's why we strive to make contributing as easy as possible and share our plans for future development in our public roadmap. 4 | 5 |
6 | 7 | ## Roadmap 8 | 9 | Serverpod's [roadmap](https://github.com/orgs/serverpod/projects/4) outlines the features and improvements that are planned for the project. The roadmap is subject to change, but provides a good overview over work in progress and what is planned for the future. 10 | 11 | If you are considering contributing code to Serverpod, please check the roadmap to see if your contribution aligns with the project's goals. 12 | 13 | ## Contributions 14 | 15 | There are many ways to contribute to Serverpod’s development. If you're interested, check out our [contribution guidelines](https://github.com/serverpod/serverpod/blob/main/CONTRIBUTING.md) to learn how you can contribute code, report bugs, and suggest improvements. 16 | -------------------------------------------------------------------------------- /versioned_docs/version-2.6.0/10-contribute.md: -------------------------------------------------------------------------------- 1 | # Roadmap & contributions 2 | 3 | Serverpod is built by the community, for the community. We believe the best software comes from collaboration, where many people contribute their ideas and skills. That's why we strive to make contributing as easy as possible and share our plans for future development in our public roadmap. 4 | 5 |
6 | 7 | ## Roadmap 8 | 9 | Serverpod's [roadmap](https://github.com/orgs/serverpod/projects/4) outlines the features and improvements that are planned for the project. The roadmap is subject to change, but provides a good overview over work in progress and what is planned for the future. 10 | 11 | If you are considering contributing code to Serverpod, please check the roadmap to see if your contribution aligns with the project's goals. 12 | 13 | ## Contributions 14 | 15 | There are many ways to contribute to Serverpod’s development. If you're interested, check out our [contribution guidelines](https://github.com/serverpod/serverpod/blob/main/CONTRIBUTING.md) to learn how you can contribute code, report bugs, and suggest improvements. 16 | -------------------------------------------------------------------------------- /versioned_docs/version-2.7.0/10-contribute.md: -------------------------------------------------------------------------------- 1 | # Roadmap & contributions 2 | 3 | Serverpod is built by the community, for the community. We believe the best software comes from collaboration, where many people contribute their ideas and skills. That's why we strive to make contributing as easy as possible and share our plans for future development in our public roadmap. 4 | 5 |
6 | 7 | ## Roadmap 8 | 9 | Serverpod's [roadmap](https://github.com/orgs/serverpod/projects/4) outlines the features and improvements that are planned for the project. The roadmap is subject to change, but provides a good overview over work in progress and what is planned for the future. 10 | 11 | If you are considering contributing code to Serverpod, please check the roadmap to see if your contribution aligns with the project's goals. 12 | 13 | ## Contributions 14 | 15 | There are many ways to contribute to Serverpod’s development. If you're interested, check out our [contribution guidelines](https://github.com/serverpod/serverpod/blob/main/CONTRIBUTING.md) to learn how you can contribute code, report bugs, and suggest improvements. 16 | -------------------------------------------------------------------------------- /versioned_docs/version-2.8.0/10-contribute.md: -------------------------------------------------------------------------------- 1 | # Roadmap & contributions 2 | 3 | Serverpod is built by the community, for the community. We believe the best software comes from collaboration, where many people contribute their ideas and skills. That's why we strive to make contributing as easy as possible and share our plans for future development in our public roadmap. 4 | 5 |
6 | 7 | ## Roadmap 8 | 9 | Serverpod's [roadmap](https://github.com/orgs/serverpod/projects/4) outlines the features and improvements that are planned for the project. The roadmap is subject to change, but provides a good overview over work in progress and what is planned for the future. 10 | 11 | If you are considering contributing code to Serverpod, please check the roadmap to see if your contribution aligns with the project's goals. 12 | 13 | ## Contributions 14 | 15 | There are many ways to contribute to Serverpod’s development. If you're interested, check out our [contribution guidelines](https://github.com/serverpod/serverpod/blob/main/CONTRIBUTING.md) to learn how you can contribute code, report bugs, and suggest improvements. 16 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "serverpod-docs", 3 | "version": "0.0.0", 4 | "private": true, 5 | "scripts": { 6 | "docusaurus": "docusaurus", 7 | "start": "docusaurus start", 8 | "build": "docusaurus build", 9 | "swizzle": "docusaurus swizzle", 10 | "deploy": "docusaurus deploy", 11 | "clear": "docusaurus clear", 12 | "serve": "docusaurus serve", 13 | "write-translations": "docusaurus write-translations", 14 | "write-heading-ids": "docusaurus write-heading-ids", 15 | "lint": "markdownlint './docs/**/*.md'" 16 | }, 17 | "dependencies": { 18 | "@docusaurus/core": "3.9.2", 19 | "@docusaurus/plugin-client-redirects": "3.9.2", 20 | "@docusaurus/plugin-google-gtag": "^3.9.2", 21 | "@docusaurus/plugin-google-tag-manager": "^3.9.2", 22 | "@docusaurus/preset-classic": "3.9.2", 23 | "@docusaurus/theme-mermaid": "^3.9.2", 24 | "@mdx-js/react": "^3.1.1", 25 | "clsx": "^2.1.1", 26 | "prism-react-renderer": "^2.4.1", 27 | "react": "^19.2.3", 28 | "react-dom": "^19.2.3", 29 | "react-player": "^3.4.0" 30 | }, 31 | "engines": { 32 | "node": ">=18.0" 33 | }, 34 | "browserslist": { 35 | "production": [ 36 | ">0.5%", 37 | "not dead", 38 | "not op_mini all" 39 | ], 40 | "development": [ 41 | "last 1 chrome version", 42 | "last 1 firefox version", 43 | "last 1 safari version" 44 | ] 45 | }, 46 | "devDependencies": { 47 | "docusaurus-plugin-snipsync": "^1.0.0", 48 | "snipsync": "^1.12.0" 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /docs/06-concepts/11-authentication/11-legacy/03-working-with-users.md: -------------------------------------------------------------------------------- 1 | # Working with users 2 | 3 | It's a common task to read or update user information on your server. You can always retrieve the id of a signed-in user through the session object. 4 | 5 | ```dart 6 | var userId = (await session.authenticated)?.userId; 7 | ``` 8 | 9 | If you sign in users through the auth module, you will be able to retrieve more information through the static methods of the `Users` class. 10 | 11 | ```dart 12 | var userInfo = await Users.findUserByUserId(session, userId!); 13 | ``` 14 | 15 | The `UserInfo` is automatically populated when the user signs in. Different data may be available depending on which method was used for authentication. 16 | 17 | :::tip 18 | 19 | The `Users` class contains many other convenient methods for working with users. You can find the full documentation [here](https://pub.dev/documentation/serverpod_auth_server/latest/serverpod_auth_server/Users-class.html). 20 | 21 | ::: 22 | 23 | ## Displaying or editing user images 24 | 25 | The module has built-in methods for handling a user's basic settings, including uploading new profile pictures. 26 | 27 | ![UserImageButton](https://github.com/serverpod/serverpod/raw/main/misc/images/user-image-button.png) 28 | 29 | To display a user's profile picture, use the `CircularUserImage` widget and pass a `UserInfo` retrieved from the `SessionManager`. 30 | 31 | To edit a user profile image, use the `UserImageButton` widget. It will automatically fetch the signed-in user's profile picture and communicate with the server. 32 | --------------------------------------------------------------------------------