📚 Canonical Documentation (19 Core Documents + Index)

Consolidated from 263 files. Every document name tells you EXACTLY what's inside. Updated: October 9, 2025

🎯 PRD (Product Requirements Doc)

THE MAIN REQUIREMENTS - Was 'technical_blueprint'

View PRD →

📜 CHANGELOG.md

Version history and release notes (v0.39.0)

View →

⚙️ WARP.md

Development rules, governance, and QA procedures

View →

📖 README.md

Master index to all 19 documents

View Index →

📈 PROJECT_MANAGEMENT.md

Project status, tracking (27% complete)

View →

📐 PROJECT_SCOPE.md

MVP scope, phases, deliverables

View →

🏗️ ARCHITECTURE_DESIGN.md

System architecture, CI/CD design

View →

🔄 CONSOLIDATION_MAPPING.md

Shows where ALL 263 files went!

See Mapping →

🔧 TECHNICAL_DESIGN.md

Implementation details, components

View →

🗺️ DATA_MODEL.md

Database schemas, Firestore collections

View →

🔌 API_SPECIFICATION.md

All API endpoints and contracts

View →

👥 USER_STORIES.md

User personas and use cases

View →

🧪 TEST_PLAN.md

Test cases and test results

View →

✅ QA_PLAN.md

Quality assurance procedures

View →

🚀 DEPLOYMENT_GUIDE.md

CI/CD, Firebase deployment

View →

🔒 SECURITY_COMPLIANCE.md

Security audit, compliance

View →

⚠️ RISK_MANAGEMENT.md

Risk register and mitigation

View →

🔄 CHANGE_MANAGEMENT.md

Change control, rollback procedures

View →

🔧 MAINTENANCE_SUPPORT.md

System maintenance procedures

View →

📣 COMMUNICATION_PLAN.md

Stakeholder communication strategy

View →

🎓 TRAINING_DOCUMENTATION.md

User guides, contributing guide

View →

🔍 POST_IMPLEMENTATION_REVIEW.md

Honest assessment, lessons learned

View →

Getting Started

Welcome to the Assiduous Realty development documentation. This guide will help you understand the platform architecture, development workflow, and best practices.

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v16 or higher)
  • Git
  • Python 3.8+
  • PostgreSQL 13+

Installation

Clone the repository and install dependencies:

git clone https://github.com/SirsiMaster/Assiduous.git cd Assiduous npm install python -m venv venv source venv/bin/activate pip install -r requirements.txt

Development Server

Start the development server:

# Start the Python HTTP server python -m http.server 8080 # Or use Node.js npm run dev

System Architecture

The Assiduous Realty platform follows a modular architecture with clear separation of concerns.

Frontend

The frontend is built with vanilla JavaScript and uses the Assiduous Design System for consistent styling. Key technologies include:

  • HTML5 with semantic markup
  • CSS3 with custom properties
  • Vanilla JavaScript ES6+
  • Chart.js for data visualization

Backend

The backend services are organized into microservices:

  • API Gateway - Request routing and authentication
  • Property Service - Property listings and management
  • User Service - Authentication and user management
  • Analytics Service - Data processing and reporting

Database

PostgreSQL is used as the primary database with the following schema structure:

-- Example schema CREATE TABLE properties ( id SERIAL PRIMARY KEY, title VARCHAR(255), price DECIMAL(10, 2), created_at TIMESTAMP DEFAULT NOW() );

API Reference

The Assiduous API provides RESTful endpoints for all platform operations.

Authentication

All API requests require authentication using Bearer tokens:

Authorization: Bearer YOUR_API_TOKEN

Endpoints

GET /api/v1/properties

Retrieve a list of all properties

POST /api/v1/properties

Create a new property listing

PUT /api/v1/properties/{id}

Update an existing property

DELETE /api/v1/properties/{id}

Delete a property listing

Response Format

All API responses follow a consistent JSON structure:

{ "success": true, "data": { // Response data }, "message": "Operation successful", "timestamp": "2024-12-14T10:30:00Z" }

Deployment

The platform can be deployed using various methods depending on your infrastructure.

Docker Deployment

# Build the Docker image docker build -t assiduous-realty . # Run the container docker run -p 8080:8080 assiduous-realty

GitHub Pages

For static hosting, the platform can be deployed to GitHub Pages:

# Push to gh-pages branch git checkout -b gh-pages git push origin gh-pages

Environment Variables

Configure the following environment variables for production:

  • DATABASE_URL - PostgreSQL connection string
  • API_KEY - API authentication key
  • NODE_ENV - Set to "production"
  • PORT - Server port (default: 8080)

Contributing

We welcome contributions to the Assiduous Realty platform. Please follow these guidelines:

Code Style

  • Use 4 spaces for indentation
  • Follow ES6+ JavaScript standards
  • Write descriptive commit messages
  • Add tests for new features

Pull Request Process

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request with a clear description

Testing

Run the test suite before submitting:

npm test python -m pytest