Repository navigation
docs: make the onboarding path work when followed literally - #148
Merged
Merged
Conversation
Re-ran the tutorials and README quick start in fresh apps from the published 0.2.0 gem. Fixes found: - TUTORIAL said SQLite is fine; migrations use jsonb and fail - TUTORIAL pointed at /auth/sign_up (real: /auth/registration/new) - both tutorials had readers add mounts/includes the generators write - missing steps everywhere: bundle install after each generator (teams fails to boot after billing adds stripe), db:encryption:init + credentials (sign-up 500s without), tailwindcss:build after design - GETTING_STARTED generated auth before core - Engine Catalogue wiring example mounted Core at / and omitted admin; now shows the generated routes and which includes are manual - README docs links use davidslv.uk/seams (github.io redirects there)
Merged
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.
I followed the onboarding docs literally in fresh apps built from the published 0.2.0 gem. They didn't work as written.
What broke
jsonband fail on SQLite (verified)./auth/sign_up, which returns 404. The real path is/auth/registration/new.mountlines andinclude Auth::Authentication, which the generators already write.bundle installbetween generators. Billing addsstripe, so the next generator fails to boot the app (verified:teamsfailed).Missing Active Record encryption credential(verified).tailwindcss:buildafterdesign --shell. Pages return 500 withThe asset 'tailwind.css' was not found(verified).authbeforecore./(the generator uses/core), left out admin, and didn't say which includes are manual.Verified after the fix
rails new --database=postgresql,bundle add seams, install, core, auth,design --shell, Tailwind build, encryption keys, migrate. Sign-up returns 302 and lands on the dashboard with 200.bundle installafter each: migrate passes,bin/seams listshows 7 engines, sign-up works.skip_before_action :authenticate_identity!on sign-in, sign-up and password reset, so the catalogue's app-widebefore_actionadvice is safe.