Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the quickstart to use the new 1.0 API #130

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

cloutiertyler
Copy link
Contributor

@cloutiertyler cloutiertyler commented Jan 22, 2025

Description of Changes

I've renamed the examples/quickstart directory to examples/quickstart-chat for standardization purposes, and also updated the quickstart example project to be in line with the new 1.0 API and the new quickstart guide in the docs: clockworklabs/spacetime-docs#141.

Note that I have also moved the implementation of the example from quickstart-chat to quickstart-chat/client. I felt that this would allow for people to have a root directory with client and server. I will note that this is not how https://github.com/clockworklabs/SpacetimeDB/tree/master/crates/sdk/examples/quickstart-chat does it, so I'm open to change it back one level up if that is preferred. We would need to update the tutorial in that case.

API

This is not an API breaking change.

Requires SpacetimeDB PRs

I do not believe it needs any.

Copy link

changeset-bot bot commented Jan 22, 2025

⚠️ No Changeset found

Latest commit: 145e818

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

pkg-pr-new bot commented Jan 22, 2025

Open in Stackblitz

npm i https://pkg.pr.new/@clockworklabs/spacetimedb-sdk@130

commit: 667c0fc

@gefjon
Copy link
Contributor

gefjon commented Jan 24, 2025

Note that I have also moved the implementation of the example from quickstart-chat to quickstart-chat/client. I felt that this would allow for people to have a root directory with client and server. I will note that this is not how https://github.com/clockworklabs/SpacetimeDB/tree/master/crates/sdk/examples/quickstart-chat does it, so I'm open to change it back one level up if that is preferred. We would need to update the tutorial in that case.

I would prefer not to have the server code duplicated in a bunch of different places. I would much prefer that each client SDK repo contain only its client code, with a README linking to the module code in the main SpacetimeDB repository. Failing that, I would accept CI jobs which verify that the module code is line-for-line equal in the two repos. I want to avoid a situation (which we've been in several times in the past) in which each repo defines its own "quickstart-chat" module, with all the versions being different and mutually incompatible.

@cloutiertyler
Copy link
Contributor Author

I would prefer not to have the server code duplicated in a bunch of different places. I would much prefer that each client SDK repo contain only its client code, with a README linking to the module code in the main SpacetimeDB repository. Failing that, I would accept CI jobs which verify that the module code is line-for-line equal in the two repos. I want to avoid a situation (which we've been in several times in the past) in which each repo defines its own "quickstart-chat" module, with all the versions being different and mutually incompatible.

Whoops! Apologies, that was supposed to be removed, not changed. Fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants