Repository navigation
Fix: docs(frontend): add frontend/README.md for local dev onboarding - #1674
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.
Closes #1668
Summary
This is a documentation-only change; no code or config files are modified. The existing frontend/README.md already contains a 'Styling conventions (CSP-safe, no inline styles)' section — preserve it and integrate the new onboarding content (overview, setup, scripts, directory structure, testing, links) around it rather than overwriting. Verify the script list matches package.json exactly, including the newer scripts (test:a11y, test:ci, test:e2e:ci, a11y:all, playwright:install, analyze, bundlewatch). Note the i18n guide currently only supports 'en'; do not list es/fr/de as supported. Do not add inline styles in any example code snippets, per the CSP rule documented in the file.
Changes
npm install, the requiredNEXT_PUBLIC_API_URLenvironment variable (defaulting to http://localhost:3001 in tests per jest.config.js), andnpm run devto start the Next.js dev server on http://localhost:3000. (frontend/README.md)@/path alias, e2e/ excluded) and e2e tests with Playwright (config in playwright.config.ts, mocked specs run on every PR, integration specs require a live backend and run on merge to main, staging project activated via STAGING_URL, baseURL via BASE_URL,npm run playwright:installfirst). Include the relevant commands. (frontend/README.md)