Developer
46 lines
4.3 KiB
Markdown
46 lines
4.3 KiB
Markdown
# .
|
|
dir: .
|
|
|
|
index: ./.pi-map.index.md
|
|
|
|
## Project Map Protocol
|
|
|
|
1. Read this protocol and the root `.pi-map.index.md` first.
|
|
2. Use `index:` / `map:` references to open relevant directory indexes and maps.
|
|
3. Load indexes before rich maps during task-start navigation.
|
|
4. Read the local rich map and actual source before editing.
|
|
5. Treat non-empty `## dirty` sections in either artifact as stale.
|
|
6. If source and generated artifacts disagree, trust source.
|
|
7. If map and index disagree, trust neither blindly; verify from source and regenerate the pair.
|
|
8. After editing source, run `project_map_patch` for each changed file.
|
|
9. Before broad architectural claims or final handoff, run `project_map_validate` when freshness matters.
|
|
|
|
Trust boundary: index routes, map orients, source decides.
|
|
|
|
## role
|
|
A self-hosted web platform for managing projects, git repositories, and development tools with OAuth2 authentication, built as a Dockerized multi-service application.
|
|
## files
|
|
- .env.example | Template environment configuration file defining all required and optional environment variables for a multi-service application stack
|
|
- .gitignore | Specifies patterns for files and directories that Git should ignore in this project. | dep: git
|
|
- AGENTS.md | Defines agent behavior rules, workflow procedures, and project conventions for AI agents working on an OpenSpec-driven codebase. | dep: OpenSpec, git, superpowers workflow system, conventional commits
|
|
- CHANGELOG.md | Documents version history and notable changes to a project management and Git repository application
|
|
- Makefile | Provides standard development commands for managing a Docker Compose-based multi-service application (API, web, Postgres, Redis) with testing, migration, linting, and build automation. | dep: docker compose, alembic, pytest, ruff, mypy, playwright, npm/node
|
|
- README.md | A self-hosted platform for managing projects, git repositories, and development tools with OAuth2 authentication. | dep: FastAPI, SQLAlchemy, Pydantic, Alembic, python-jose, React, TypeScript, Vite, React Router, Docker, PostgreSQL, Traefik, Authentik
|
|
- docker-compose.traefik.yml | Deploys a multi-service web application stack (frontend, API, PostgreSQL, Redis) behind an existing Traefik reverse proxy with automatic HTTPS | dep: Docker, Docker Compose, Traefik, PostgreSQL, Redis, Authentik
|
|
- docker-compose.yml | Defines a multi-container Docker application with PostgreSQL, Redis, API backend, and web frontend services for a "headquarter" application. | dep: Docker Compose, PostgreSQL 15, Redis 7, Python/FastAPI (implied by asyncpg), Vite/Node.js (implied by web build), Alpine Linux
|
|
- progress.md | Documents the completed phases and remaining work of a backend-frontend code refactoring project involving modularization, subpackage extraction, and file reorganization.
|
|
- swap-pane | Swaps two tmux panes between windows, preserving active pane state and layout | dep: tmux
|
|
- ui-audit-spacing-typography.md | Documents a comprehensive UI audit of spacing, typography, and visual rhythm issues in a React web application, identifying missing CSS classes, unstyled mobile components, inconsistent design tokens, and layout bugs across component and stylesheet files. | dep: React/TSX components, CSS modules/stylesheets, CSS custom properties (tokens), mobile-specific components, design system tokens
|
|
- ui-rework-foundations-apply.md | Documents the implementation of Pass 1 (Foundations) of a web UI spacing/typography/visual-rhythm rework, including token expansion, primitive CSS classes, component updates, and validation results. | dep: CSS design tokens, React/TSX components, OpenSpec documentation system, git/SSH, npm build toolchain
|
|
- ui-rework-pass2-apply.md | Documents a completed web UI refactoring pass that converted inline styles to token-based utility classes, unified form patterns, and added component utilities across multiple React components. | dep: React, CSS custom properties, OpenSpec, Git, npm, TypeScript, ESLint
|
|
## arch
|
|
Full-stack monolithic architecture with React frontend, API backend, PostgreSQL and Redis services, containerized via Docker Compose, using Traefik for reverse proxy/HTTPS, and following a token-based design system for UI consistency.
|
|
## tags
|
|
docker, application, git, web, react, ui, documents, rework
|
|
## symbols
|
|
-
|
|
## workflows
|
|
-
|
|
## dirty
|
|
-
|