Refine Starter Docs And API Guidance Based On Initial Trainee Feedback#64
Open
oleksiybondar wants to merge 28 commits into
Open
Refine Starter Docs And API Guidance Based On Initial Trainee Feedback#64oleksiybondar wants to merge 28 commits into
oleksiybondar wants to merge 28 commits into
Conversation
Co-authored-by: Adam Blanchard <adamgoodie@gmail.com>
Co-authored-by: Adam Blanchard <adamgoodie@gmail.com>
Co-authored-by: Adam Blanchard <adamgoodie@gmail.com>
…f Swagger/Express path wars definition descripency
…ration and scripts accordingly.
…instructions for creating migrations and seeds.
…rminalMiddlewares`. Add error handlers (`apiNotFoundHandler`, `apiErrorHandler`) and update setup in `index.mjs`. Expand README with middleware usage guidelines.
…, adding dependencies, and managing environment variables.
…ntrollers. Update `listEvents` with pagination, add new schemas for events, and improve error handling with detailed `ZodError` support. Update README with validation examples and guidance.
…pi/README.md`. Add guidance on aligning starter examples with project contracts.
Co-authored-by: Adam Blanchard <adamgoodie@gmail.com>
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
2 participants
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.
Summary
Refines the backend starter based on early trainee feedback. Focuses on reducing setup ambiguity, clarifying structure, and making common patterns easier to find without turning it into a full tutorial.
Changes
• Standardized on PostgreSQL and updated setup docs
• Added Knex CLI support (knexfile.js) + migration/seed guidance
• Clarified demo vs custom DB schema usage
• Added structured JSON API error handling
• Improved middleware guidance (before/after routes, placement, route-level usage)
• Added input validation guidance (Zod + manual options)
• Wired validation into example event controllers (query + params)
• Clarified starter scope vs full project expectations
Why
Addresses common friction points:
• DB setup
• Knex workflow
• Middleware usage
• Error handling
• Validation approach
• Starter vs project confusion
Notes
• Starter remains minimal (not a replacement for PRD/plan)
• Guidance is flexible, not prescriptive