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

Most of the Builder's tool introduction exercises are already complete in the quickstart repo #97

Open
Alastair-smith2 opened this issue Sep 14, 2024 · 0 comments

Comments

@Alastair-smith2
Copy link

Firstly a thank you for a quickstart which is easy to get up and running!

The introduction on https://automerge.org/docs/quickstart/, after downloading the quickstarter from https://github.com/automerge/automerge-repo-quickstart, states

Visit localhost:5173/automerge-repo-quickstart/ to see the app in its "starter" state, as a basic React app not yet using Automerge: the task list can be edited, but changes are not synced between users, and all local changes are lost when the page is closed or reloaded.

Let's fix all that with Automerge!

In the exercises that follow, you'll modify the source code to:

Configure a Repository to store & sync document changes locally
Create/retrieve a task list Document by its Document URL
Use the Automerge React client to update the Doc's data on user input
Update the Repo to also sync changes over the network (when available)

Checking out https://github.com/automerge/automerge-repo-quickstart, with a single branch of main, already has the majority of the "exercises" suggested done with a fully functioning app. It's not an exact 1:1 mirror of the "exercises" but doesn't leave much for a newcomer to implement themselves.

This documentation looks to have changed in 1be40d0#diff-988a5392cf907f7c5728b8ac90445facc7f835f3c00375764ec99769dcde2d5a.

Having the fully completed app is extremely useful for comparison but should be on a separate branch so new starters have a template to fill out?

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

No branches or pull requests

1 participant