Skip to content

docs: Add local setup guides for backend, admin portal and frontend - #47

Open
ptrcja wants to merge 1 commit into
Women-Coding-Community:mainfrom
ptrcja:docs/setup-guides
Open

docs: Add local setup guides for backend, admin portal and frontend#47
ptrcja wants to merge 1 commit into
Women-Coding-Community:mainfrom
ptrcja:docs/setup-guides

Conversation

@ptrcja

@ptrcja ptrcja commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

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 guide
  • docs/setup-backend.md — QA Docker stack, seeded accounts, and the tests/.env configuration
  • docs/setup-admin-portal.md — admin portal setup, including the NEXT_PUBLIC_API_KEY configuration
  • docs/setup-frontend.md — frontend setup using a local backend

The 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.md also includes a link to the new docs/ folder.

Related Issue

Closes #40

Type

  • New test coverage
  • Test fix (flaky, broken, or incorrect test)
  • Framework change (fixtures, clients, services, factories, schemas)
  • Bug fix
  • Documentation
  • Tooling / CI
  • Other

Test Evidence

The guides were followed end to end on a clean run:

  • Backend QA stack started from the documented compose command; all four accounts seeded.
  • Login as [email protected] returned a token. X-API-KEY: local returned 200, its absence 401.
  • npm run test:api — 3 passed
  • npm run test:admin — 3 passed (the setup project signed in as all four seeded roles)
  • The frontend .env.local block worked as written, and /mentorship/mentors rendered the seeded mentor in the browser.
  • npm run lint, npm run typecheck and npm run format all pass.

Pull request checklist

  • This PR is linked to an issue
  • npm run lint and npm run typecheck pass locally
  • Tests have been added or updated for this change
  • tests/api/TEST_PLAN.md has a row for every new test ID (API flows only)
  • No secrets committed — credentials stay in tests/.env, and no token, password, or API key is logged or hardcoded
  • I have performed a self-review of my own code

@ptrcja
ptrcja requested a review from a team as a code owner September 7, 2026 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add local setup documentation for backend, admin portal, and website

1 participant