mirror of
https://github.com/cassandra/home-information.git
synced 2026-04-17 13:08:36 -04:00
9374dc0418
Developer docs mentioned Redis as a requirement without distinguishing between local development (where you install it yourself) and Docker deployment (where it is bundled and managed by supervisord). This caused confusion for a user who set up an external Redis server not realizing the Docker image already includes one. Closes #241
1.8 KiB
1.8 KiB
Development Guide for Contributors
Requirements and Dependencies
- Python 3.11 (or higher) - installed.
- Redis - installed and running locally (bundled automatically in Docker deployments).
- A GitHub account.
Tech Stack
- Django 4.2 (back-end)
- Javascript using jQuery 3.7 (front-end)
- Bootstrap 4 (CSS)
- SQLite (database)
- Redis (caching)
Getting Started
Follow these steps in order to begin contributing:
- Environment Setup - Install and configure your development environment
- Contributor Workflow - Git workflow and pull request process
Core Guidelines (Essential Reading)
These documents contain fundamental concepts that apply across all development areas:
- Architecture Overview - High-level system design and key patterns
- Coding Standards - Code organization, style, and conventions
- Data Model - Core domain models and relationships
- Testing Guidelines - Testing philosophy, best practices, and anti-patterns
Development Areas
Choose the area that matches your contribution focus and browse the relevant documentation:
- Backend Development - Django models, views, and business logic
- Frontend Development - Templates, styling, and user interface
- Testing - Testing standards and patterns
- Integration Development - External service integration and API patterns
- Domain & Data Modeling - Domain modeling and business logic
- Shared Reference - Common concepts used across all areas