pacnpal/thrillwiki_django_no_react
1
1
Fork 0
mirror of https://github.com/pacnpal/thrillwiki_django_no_react.git synced 2025-12-20 05:31:09 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
8d70bf89945dff6d6c40a2986778f2684956d62c
thrillwiki_django_no_react/cline_docs/techContext.md
pacnpal 8d70bf8994 [Documentation] Create context documentation system 
- Created comprehensive documentation structure
- Added productContext.md for product understanding
- Added activeContext.md for current development status
- Added systemPatterns.md for architecture patterns
- Added developmentWorkflow.md for process standards
- Added operationalContext.md for runtime details
- Added projectBoundaries.md for technical constraints
- Added techContext.md for technology stack
- Documented all major aspects of the system
- Established foundation for maintaining context
2024-11-13 23:40:36 +00:00

4.3 KiB
Raw Blame History

Technical Context

Core Technologies

Backend Framework

  1. Django

    • MVT architecture
    • ORM for data management
    • Template system
    • URL routing
    • Form handling
    • Authentication
    • Admin interface

  2. Python

    • Version requirements
    • Core libraries
    • Package management
    • Virtual environments

Frontend Technologies

  1. HTMX

    • Dynamic updates
    • Partial rendering
    • Server-side processing
    • Progressive enhancement

  2. AlpineJS

    • UI state management
    • Component behavior
    • Event handling
    • DOM manipulation

  3. Tailwind CSS

    • Utility-first styling
    • Component design
    • Responsive layouts
    • Custom configuration

Integration Patterns

Template System

  1. Base Structure

    • Base templates
    • Partial templates by model
    • Component reuse
    • Template inheritance

  2. HTMX Integration

    • Partial updates
    • Server triggers
    • Event handling
    • Response processing

Data Flow

  1. Model Layer

    • Django ORM
    • Database schema
    • Relationships
    • Validation rules

  2. View Layer

    • Class-based views
    • Function views
    • Mixins
    • Decorators

  3. Template Layer

    • Django templates
    • HTMX partials
    • AlpineJS components
    • Tailwind styles

Key Libraries/Frameworks

Django Extensions

  1. Core Apps

    • django.contrib.auth
    • django.contrib.admin
    • django.contrib.sessions
    • django.contrib.messages

  2. Third-Party

    • django-tailwind
    • django-htmx
    • Additional dependencies

Frontend Libraries

  1. CSS Framework

    • Tailwind CSS
    • Custom plugins
    • Theme configuration
    • Utility classes

  2. JavaScript

    • AlpineJS core
    • HTMX library
    • Utility functions
    • Custom components

Infrastructure Choices

Development Environment

  1. Local Setup

    • Python environment
    • Django configuration
    • Tailwind setup
    • Development server

  2. Tools

    • VSCode
    • Git
    • Package managers
    • Development utilities

Production Environment

  1. Hosting

    • Server requirements
    • Domain configuration
    • SSL/TLS setup
    • Static/media serving

  2. Services

    • Database hosting
    • File storage
    • Email service
    • Monitoring tools

Technical Constraints

Development Rules

  1. Code Standards

    • Python style guide
    • Django best practices
    • Frontend patterns
    • Documentation requirements

  2. Process Requirements

    • Git workflow
    • Testing standards
    • Review process
    • Deployment steps

Technology Limitations

  1. Frontend

    • HTMX/AlpineJS only
    • No additional frameworks
    • Browser compatibility
    • Performance requirements

  2. Backend

    • Django version constraints
    • Database limitations
    • API restrictions
    • Security requirements

Development Environment

Local Setup

  1. Required Software

    • Python
    • pip
    • Git
    • Node.js (for Tailwind)

  2. Configuration

    • Environment variables
    • Development settings
    • Database setup
    • Media handling

Development Tools

  1. Editor Setup

    • VSCode configuration
    • Extensions
    • Linting
    • Formatting

  2. Testing Tools

    • Django test runner
    • Coverage tools
    • Browser testing
    • Performance testing

Version Control

Git Configuration

  1. Repository Structure

    • Main branch workflow
    • Commit standards
    • Push requirements
    • Version tracking

  2. Process

    • Commit messages
    • Code review
    • Documentation
    • Deployment

Dependencies

Python Packages

  1. Core Dependencies

    • Django
    • Database adapters
    • Utility packages
    • Testing tools

  2. Development Dependencies

    • Debug tools
    • Testing utilities
    • Documentation generators
    • Linting tools

Frontend Dependencies

  1. Required Packages

    • Tailwind CSS
    • AlpineJS
    • HTMX
    • Development tools

  2. Build Tools

    • Node.js
    • npm/yarn
    • Build scripts
    • Asset compilation

Documentation Standards

Code Documentation

  1. Python

    • Docstrings
    • Type hints
    • Comments
    • README files

  2. Templates

    • Component documentation
    • HTMX attributes
    • AlpineJS directives
    • Style classes

Technical Documentation

  1. System Documentation

    • Architecture overview
    • Setup guides
    • Deployment process
    • Maintenance procedures

  2. Developer Guides

    • Getting started
    • Best practices
    • Common patterns
    • Troubleshooting
Reference in New Issue View Git Blame Copy Permalink