You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 2a6599e
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/static/llms.md
+21Lines changed: 21 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,14 +99,35 @@ A module is a collection of functions and schema definitions, which can be writt
99
99
Step-by-step guides for common tasks.
100
100
101
101
-[How To Guides](/docs/how-to): Step-by-step guides for common tasks.
102
+
-[Admin and moderator roles](/docs/how-to/app-patterns/admin-roles): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first.
103
+
-[Call an AI model from your module](/docs/how-to/app-patterns/call-ai-model): You need a module and a client connected to it, and an API key from the provider of the AI model you want to use. If you don't have a module yet, follow the quickstart for your language first.
104
+
-[Call an AI model from a sidecar](/docs/how-to/app-patterns/call-ai-model-sidecar): You need a module and a client connected to it, Node.js to run the sidecar, and an API key from the provider of the AI model you want to use. If you don't have a module yet, follow the quickstart for your language first.
105
+
-[Call an external API from your module](/docs/how-to/app-patterns/call-external-api): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first. This guide uses Open-Meteo, a weather API you can call without an API key. Its free API is for non-commercial use, so check its terms before you ship.
106
+
-[Paginate or infinite-scroll a large table](/docs/how-to/app-patterns/pagination): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first.
107
+
-[Seed initial data on first publish](/docs/how-to/app-patterns/seed-initial-data): You need a module you can publish. If you don't have one yet, follow the quickstart for your language first.
108
+
-[Send an email from your module](/docs/how-to/app-patterns/send-email): You need a module and a client connected to it, and an API key from an email provider. This guide uses Resend. If you don't have a module yet, follow the quickstart for your language first.
109
+
-[Store files in S3](/docs/how-to/app-patterns/store-files-in-s3): You need a module and a client connected to it, and an Amazon S3 bucket, or a bucket on an S3-compatible service such as Cloudflare R2. If you don't have a module yet, follow the quickstart for your language first.
102
110
-[Maincloud](/docs/how-to/deploy/maincloud): Maincloud is SpacetimeDB's fully managed serverless platform. It handles infrastructure, scaling, replication, and backups so you can focus on building your application. Maincloud scales to zero when your database is idle, so you only pay for what you use.
103
111
-[Railway](/docs/how-to/deploy/railway): Railway is a hosted platform for deploying infrastructure and application services. If you want to run SpacetimeDB without managing your own VM, the official Railway template is a quick way to get started.
104
112
-[Self-hosting](/docs/how-to/deploy/self-hosting): This tutorial will guide you through setting up SpacetimeDB on an Ubuntu 24.04 server, securing it with HTTPS using Nginx and Let's Encrypt, and configuring a systemd service to keep it running.
113
+
-[Run a fixed-rate game tick](/docs/how-to/games/fixed-rate-game-tick): You need a module you can publish. If you don't have one yet, follow the quickstart for your language first.
114
+
-[Hide information from players](/docs/how-to/games/hide-information): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first.
115
+
-[Build a matchmaking queue](/docs/how-to/games/matchmaking-queue): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first.
116
+
-[Reset a leaderboard each season](/docs/how-to/games/seasonal-leaderboard-reset): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first.
117
+
-[Skill-based matchmaking with OpenSkill](/docs/how-to/games/skill-based-matchmaking): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first. This guide builds on Build a matchmaking queue, so read that one first.
118
+
-[Only sync what's near the player](/docs/how-to/games/sync-nearby-entities): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first.
119
+
-[How to make a top 100 leaderboard](/docs/how-to/games/top-100-leaderboard): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first.
120
+
-[Make a turn-based game with turn timeouts](/docs/how-to/games/turn-based-game): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first.
105
121
-[Logging](/docs/how-to/logging): SpacetimeDB provides logging capabilities for debugging and monitoring your modules. Log messages are private to the database owner and are not visible to clients.
-[Reject Client Connections](/docs/how-to/reject-client-connections): SpacetimeDB provides a way to disconnect a client during a client connection attempt.
108
124
-[Row Level Security](/docs/how-to/rls): Row Level Security is an experimental, unstable feature. The API may change or be removed in future releases.
109
125
-[Azure Self-Hosted VMs + Key Rotation & Key Vault](/docs/how-to/self-hosted-key-rotation): This guide explains how JWT signing key rotation works in self-hosted SpacetimeDB and how to avoid breaking spacetime publish during rotation.
126
+
-[Chat rooms and private DMs](/docs/how-to/social/chat-rooms-and-dms): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first. This guide uses a minimal player table with a name, and doesn't cover how players get their row. To let players pick a unique name and block offensive ones, see Keep usernames unique and block offensive ones: the code here works the same with its player table.
127
+
-[Build a friends or follow list](/docs/how-to/social/friends-list): You need a module and a client connected to it. If you don't have them yet, follow the quickstart for your language first. This guide uses a minimal player table with a name, and doesn't cover how players get their row. To let players pick a unique name and block offensive ones, see Keep usernames unique and block offensive ones: the code here works the same with its player table.
128
+
-[Typing indicators and other short-lived signals](/docs/how-to/social/typing-indicators): You need a chat app. This guide builds on the one from the chat app tutorial: it uses its user and message tables, and its send_message reducer. If you don't have a chat app yet, follow the tutorial for your language first.
129
+
-[Keep usernames unique and block offensive ones](/docs/how-to/social/unique-usernames): You need a module and a client connected to it, and an OpenAI API key. If you don't have a module yet, follow the quickstart for your language first.
130
+
-[Unread counts and notifications](/docs/how-to/social/unread-counts): This guide builds on Chat rooms and private DMs: it uses its tables, its find_membership function, its views and its client. If you haven't built chat rooms yet, follow that guide first.
110
131
-[Unit Test Modules](/docs/how-to/unit-testing): A module's reducers, procedures and views are ordinary functions, and most of what they do is read and write tables. Spacetime includes a test harness that runs those functions against an in-memory datastore built from your module's schema, so you can unit test them without publishing a database or running a Spacetime host.
0 commit comments