Developer
24 lines
1.7 KiB
Markdown
24 lines
1.7 KiB
Markdown
# docs/development
|
|
dir: docs/development
|
|
|
|
index: docs/development/.pi-map.index.md
|
|
|
|
## role
|
|
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, 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
|
|
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
|
|
testing, contributing, setup, review, quality, gates, backend, frontend
|
|
## symbols
|
|
-
|
|
## workflows
|
|
-
|
|
## dirty
|
|
-
|