Repository navigation
docs(readme): create the project with npx and open the onboarding address - #5
Merged
Merged
Conversation
This file contains hidden or 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
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.
Why
A newcomer with nothing installed should create a project with one copy-pasteable
npx @antelopejs/corecommand and a short template slug, not agit cloneof the template repository. The first-run text must also match today's onboarding flow. The backend prints a setup address with a token, and the wizard needs that address.What changed
npx @antelopejs/core project init my-project --template dms-starterin place ofgit clone.dmslog with Docker, or thepnpm devterminal without it. It also coversDMS_SETUP_TOKEN.project initinstalls the packages with pnpm.Scope
Blast Radius
Docs only. The slug works only once a core release ships template slugs. Today, core 1.19.0 matches only the display name. Merge this after that release.
The Docker prerequisites no longer list pnpm, and the
corepack enablestep is gone. This works only with the core release that ships AntelopeJS/antelopejs#381 and the interfaces PR AntelopeJS/interfaces#14 ("install": falseon this template). Merge after both.Verification
npx -y @antelopejs/core project init dms-starter --template "DMS Starter" --yescreated the project, installed it, and rangit init.@antelopejs/dms0.15.1 that the connect demo resolves. In that demo,docker compose upprinted the line in thedmslog, and the address opened the wizard.