clockworklabs / clockworklabs/SpacetimeDB

Documentation fixes for demo

Open
#278 1 comment 0 reactions 1 assignee View on GitHub

@dbrinkmanncw is already working on this.

Since Sep 12, 2023.

possibly-stale
Dominant language
Rust
Stars
25.2k
Forks
1.1k
Avg merge
2d 7h
Merged PRs (30d)
46

Description

I've just tried your demo's to get a feel for your system, and I ran into a few issues (running WSL2, Ubuntu 22.04, node.js 18.17). Perhaps you can update the documentation.

Rust server

  • I had a fresh install of WSL2, and needed to install pkg-config in order to get the example to compile (Open SSL issue): sudo apt install pkg-config.
  • When publishing the server module, I received an authorization error, indicating that my current identity was not authorized to publish. I needed to remove all identities first using: spacetime identity remove --all --force
  • I could not find any documentation to delete existing modules (which is sometimes needed, e.g. when you publish the default Rust server project, and want to later update it with the example server - the Person schema's are not compatible). spacetime delete <module-name>

Rust client

  • Worked smoothly: I would probably start with the connection to the DB, but that's just my preference. And it would be nice if the code would allow me to set my name, for example when starting the app.

Typescript client:

  • There is another OpenSSL issue: in this case, I needed to update the react-scripts: npm i react-scripts@latest.
  • There were 3 code errors related to the user identity type, which needed to be updated to Uint8Array: user.identity.toUint8Array()
  • The tsconfig.json needed to be updated: target: ESnext.
  • The default npm start command starts the client on port 3000, which is a bit annoying, since spacetime is using the same port.
  • At the end of the react example, there is a link to the full example source code Congratulations! You've built a simple chat app with SpacetimeDB. You can find the full source code for this app [here](https://github.com/clockworklabs/spacetimedb-typescript-sdk/tree/main/examples/quickstart). However, that page no longer exists.
  • When I set my name, the system displays 'name has connected' 15 times instead of once.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.