docs: Add local setup guides for backend, admin portal and frontend - #47
Open
ptrcja wants to merge 1 commit into
Open
docs: Add local setup guides for backend, admin portal and frontend#47ptrcja wants to merge 1 commit into
ptrcja wants to merge 1 commit into
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.
Description
Adds a
docs/folder with QA-focused setup guides for each component, plus an index. The guides cover what a tester needs to set up each component and link to the component repositories for prerequisites, installation, and more detailed information instead of duplicating their READMEs.docs/README.md— overview of each component, repository, port, and setup guidedocs/setup-backend.md— QA Docker stack, seeded accounts, and thetests/.envconfigurationdocs/setup-admin-portal.md— admin portal setup, including theNEXT_PUBLIC_API_KEYconfigurationdocs/setup-frontend.md— frontend setup using a local backendThe documentation covers the backend, admin frontend, and wcc-frontend, which are the components used for testing. The WomenCodingCommunity.github.io site is not used for testing and is therefore out of scope.
The root
README.mdalso includes a link to the newdocs/folder.Related Issue
Closes #40
Type
Test Evidence
The guides were followed end to end on a clean run:
Pull request checklist
npm run lintandnpm run typecheckpass locallytests/api/TEST_PLAN.mdhas a row for every new test ID (API flows only)tests/.env, and no token, password, or API key is logged or hardcoded