chore(project-map): regenerate .pi-map artifacts across the repo
This commit is contained in:
@@ -4,16 +4,17 @@ dir: docs/development
|
||||
index: docs/development/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Developer documentation hub providing setup, contribution, quality, and testing guidelines for the Headquarter full-stack project.
|
||||
Provides comprehensive documentation for developers contributing to the Headquarter full-stack web application project.
|
||||
## files
|
||||
- contributing.md | Provides guidelines and workflows for contributing to the Headquarter project | dep: git, ruff, mypy, pytest, npm, React, TypeScript, Python
|
||||
- quality-gates.md | Defines mandatory quality gates (linting, type checking, testing, security, build) for backend (Python) and frontend (TypeScript) code before merge, including CI/CD integration and IDE setup. | dep: ruff, mypy, pytest, bandit, safety, TypeScript, ESLint, Vitest, pre-commit, npm, make
|
||||
- setup.md | Provides step-by-step instructions for setting up a full-stack development environment for a FastAPI/React application with PostgreSQL, Redis, and optional Authentik authentication. | dep: Python 3.11+, Node.js 18+, PostgreSQL 15+, Redis 7+, Git, Docker, FastAPI, React, Alembic, uvicorn, npm, Authentik
|
||||
- testing.md | Documents testing practices, frameworks, and guidelines for both backend (Python/pytest) and frontend (React/Vitest) of a web application called "Headquarter" | dep: pytest, pytest-asyncio, httpx, factory-boy, vitest, react-testing-library, jsdom, playwright, asyncpg, postgresql, authentik, github-actions
|
||||
- contributing.md | Provides guidelines and workflows for contributing to the Headquarter project, including setup, development workflow, code standards, testing, documentation, and review processes.
|
||||
- quality-gates.md | Defines mandatory quality gates and tooling configuration for backend (Python) and frontend (TypeScript/React) code before merging changes. | dep: ruff, mypy, pytest, bandit, safety, pre-commit, TypeScript, ESLint, Vitest, npm, make, GitLab CI
|
||||
- setup.md | Provides step-by-step instructions for setting up a local development environment for a full-stack web application with FastAPI backend, React frontend, PostgreSQL database, Redis cache, and optional Authentik authentication. | dep: Python, Node.js, PostgreSQL, Redis, Git, Docker, FastAPI, React, uvicorn, alembic, npm, Authentik
|
||||
- testing.md | Documentation guide for backend, frontend, and E2E testing practices in the Headquarter application | dep: pytest, pytest-asyncio, httpx, factory-boy, Vitest, React Testing Library, jsdom, Playwright, PostgreSQL, GitHub Actions
|
||||
- ui-review-checklist.md | Defines a checklist for reviewing UI changes to ensure compliance with design token standards and accessibility practices.
|
||||
## arch
|
||||
Static markdown documentation organized by concern (setup, contributing, quality, testing) with explicit FastAPI/Python backend and React/TypeScript frontend toolchain boundaries.
|
||||
Documentation-as-code pattern with structured markdown files covering setup, standards, quality gates, testing, and review processes for a FastAPI/React/PostgreSQL/Redis stack.
|
||||
## tags
|
||||
pytest, react, testing, contributing, npm, typescript, python, quality
|
||||
testing, contributing, setup, review, quality, gates, backend, frontend
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
|
||||
Reference in New Issue
Block a user