How geeksforsocialchange/placecal works
Main System Components
a) Client Layer:
• Public Web Interface (Rails Views)
• Admin Interface
• GraphQL API Endpoints
b) Application Layer:
• Controllers (Public & Admin)
• View Components
• Policies (Authorization)
• GraphQL Schema
c) Service Layer:
• Calendar Importer Jobs
• Event Processing
• Mailers
• Image Processing
d) Data Layer:
• PostgreSQL Database
• File Storage (for images)
• External Calendar Sources
Key Relationships to Highlight
a) Data Flow:
• External Calendar Sources → Calendar Importer → Events
• User Requests → Controllers → Views/Components
• API Requests → GraphQL → Models
• Admin Actions → Policies → Data Access
b) Authentication Flow:
• User Authentication (Devise)
• Admin Authorization (Pundit)
• Site-specific Access (Constraints)
Specific Implementation Details
a) Core Models (Rectangle):
• Sites
• Partners
• Events
• Calendars
• Users
• Neighbourhoods
• Tags
b) Services (Hexagon):
• Calendar Importers
• Image Processors
• Email Services
c) External Systems (Cloud):
• iCal Sources
• API Endpoints
• Email Providers
Technical Stack Elements
Technologies:
• Ruby on Rails (Application Framework)
• PostgreSQL (Database)
• ViewComponent & Mountain View (UI Components)
• GraphQL (API Layer)
• Delayed Job (Background Processing)
• Docker (Development/Deployment)
Important Architectural Patterns
Emphasize:
a) MVC Architecture:
• Models (app/models)
• Views (app/views)
• Controllers (app/controllers)
b) Component-Based UI:
• ViewComponents
• Mountain View Components
c) Service Objects:
• Calendar Importers
• Event Processors
Deployment Architecture
Include:
• Docker Containers
• Nginx Configuration
• Asset Pipeline
• Database Connections
Bottom Level: Data Storage and External Services
• Blue: User-facing components
• Green: Processing services
• Yellow: Data storage
• Red: External services/APIs
• Purple: Authentication/Authorization
Remember to highlight the multi-tenant nature of the system, showing how different sites can operate independently within the same infrastructure.