Add a create helper for node apps #224
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It's frequently useful to be able to quickly jump into a new project with the websocket network adapter and filesystem storage set up so that you can start experimenting with repo. This commit adds an NPM "initializer" which can be used as follows: npm create @automerge/node-repo-app This quickly creates an NPM package with the necessary dependencies and a simple `index.js`.
alexjg
added a commit
to automerge/automerge.github.io
that referenced
this pull request
Nov 6, 2023
The second half of the quickstart was a bit hand wavy, just suggesting that the user "in a second process (such as another tab) put the following code". This commit uses the @automerge/create-repo-node-app helper (yet to be merged: automerge/automerge-repo#224) to guide the reader through creating a node app to use as the second process.
alexjg
added a commit
to automerge/automerge.github.io
that referenced
this pull request
Nov 6, 2023
The second half of the quickstart was a bit hand wavy, just suggesting that the user "in a second process (such as another tab) put the following code". This commit uses the @automerge/create-repo-node-app helper (yet to be merged: automerge/automerge-repo#224) to guide the reader through creating a node app to use as the second process.
alexjg
added a commit
to automerge/automerge.github.io
that referenced
this pull request
Nov 8, 2023
The second half of the quickstart was a bit hand wavy, just suggesting that the user "in a second process (such as another tab) put the following code". This commit uses the @automerge/create-repo-node-app helper (yet to be merged: automerge/automerge-repo#224) to guide the reader through creating a node app to use as the second process.
alexjg
added a commit
to automerge/automerge.github.io
that referenced
this pull request
Nov 8, 2023
The second half of the quickstart was a bit hand wavy, just suggesting that the user "in a second process (such as another tab) put the following code". This commit uses the @automerge/create-repo-node-app helper (yet to be merged: automerge/automerge-repo#224) to guide the reader through creating a node app to use as the second process.
alexjg
added a commit
to automerge/automerge.github.io
that referenced
this pull request
Nov 8, 2023
The second half of the quickstart was a bit hand wavy, just suggesting that the user "in a second process (such as another tab) put the following code". This commit uses the @automerge/create-repo-node-app helper (yet to be merged: automerge/automerge-repo#224) to guide the reader through creating a node app to use as the second process.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's frequently useful to be able to quickly jump into a new project with the websocket network adapter and filesystem storage set up so that you can start experimenting with repo. This commit adds an NPM "initializer" which can be used as follows:
npm create @automerge/node-repo-app
This quickly creates an NPM package with the necessary dependencies and a simple
index.js.