7.4 KiB
7.4 KiB
Technology Stack: {{PROJECT_NAME}}
Document Version: 1.0 Date: {{DATE}} Status: {{STATUS}}
1. Introduction
1.1 Purpose
This document specifies the technology stack, frameworks, libraries, and tools used in {{PROJECT_NAME}}.
1.2 Scope
{{SCOPE}}
2. Technology Stack
2.1 Stack Overview
| Layer | Technology | Version | Rationale | ADR |
|---|---|---|---|---|
| Frontend | {{FRONTEND_FRAMEWORK}} | {{FRONTEND_VERSION}} | {{FRONTEND_RATIONALE}} | {{FRONTEND_ADR_LINK}} |
| Backend | {{BACKEND_FRAMEWORK}} | {{BACKEND_VERSION}} | {{BACKEND_RATIONALE}} | {{BACKEND_ADR_LINK}} |
| Database | {{DATABASE}} | {{DATABASE_VERSION}} | {{DATABASE_RATIONALE}} | {{DATABASE_ADR_LINK}} |
| Cache | {{CACHE}} | {{CACHE_VERSION}} | {{CACHE_RATIONALE}} | {{CACHE_ADR_LINK}} |
| Message Queue | {{QUEUE}} | {{QUEUE_VERSION}} | {{QUEUE_RATIONALE}} | {{QUEUE_ADR_LINK}} |
| Testing | {{TEST_FRAMEWORK}} | {{TEST_VERSION}} | {{TEST_RATIONALE}} | {{TEST_ADR_LINK}} |
| DevOps | {{DEVOPS_TOOLS}} | {{DEVOPS_VERSION}} | {{DEVOPS_RATIONALE}} | {{DEVOPS_ADR_LINK}} |
2.2 Key Libraries & Dependencies
Frontend: {{FRONTEND_LIBRARIES}}
Backend: {{BACKEND_LIBRARIES}}
Common: {{COMMON_LIBRARIES}}
3. Docker Development Environment
3.1 Dockerfile
{{DOCKERFILE_CONTENT}}
3.2 docker-compose.yml (Development)
{{DOCKER_COMPOSE_DEV}}
3.3 docker-compose.test.yml (Testing)
{{DOCKER_COMPOSE_TEST}}
4. Development Tools
4.1 Required Tools
| Tool | Version | Purpose | Installation |
|---|---|---|---|
| Node.js | {{NODE_VERSION}} | Runtime environment | https://nodejs.org/ |
| Docker | 24.0+ | Container runtime | https://docs.docker.com/get-docker/ |
| Git | 2.40+ | Version control | https://git-scm.com/ |
| {{IDE}} | Latest | Code editor | {{IDE_LINK}} |
4.2 VS Code Extensions (Recommended)
{{VSCODE_EXTENSIONS}}
4.3 Linters & Code Quality Tools
| Tool | Version | Purpose | Command | Config File |
|---|---|---|---|---|
| {{LINTER_1}} | {{VERSION_1}} | {{PURPOSE_1}} | {{COMMAND_1}} | {{CONFIG_1}} |
CI/CD Integration: {{CI_LINT_INTEGRATION}}
Run All Quality Checks:
{{LINT_ALL_COMMAND}}
5. Naming Conventions
5.1 File Naming
{{FILE_NAMING}}
5.2 Variable Naming
{{VARIABLE_NAMING}}
5.3 Database Naming
{{DATABASE_NAMING}}
6. Maintenance
Last Updated: {{DATE}}
Update Triggers:
- Technology version upgrade (major/minor releases)
- New library added to dependencies
- Docker configuration changes
- Development tool updates
Verification:
- All versions match package.json/Dockerfile
- ADR links valid and point to correct decisions
- Docker compose files tested and working
- All listed tools accessible with installation links
Version: 1.0.0 Template Last Updated: 2025-11-16