How guilhermeguerraf/time-to-answer works
Project type and purpose
• This is a full-stack Ruby on Rails web application (“Time to Answer”), a Q&A site with three user roles—public visitors, registered users, and administrators—and features such as authentication (Devise), search (Searchkick + ElasticSearch), pagination (Kaminari), PDF generation (Prawn), internationalization, and WYSIWYG editing (Trix).
File structure
• Top-level Rails structure:
• app/controllers → MVC controllers, split into three namespaces: site (public), users_backoffice, admins_backoffice
• app/models → domain models (Question, Answer, Subject, User/UserProfile/UserStatistic, Admin/AdminStatistic, Favorite, Cep)
• app/views → ERB templates, organized per namespace
• app/assets & lib/assets → front-end assets (CoffeeScript/JS, SCSS/CSS)
• config → Rails configuration, routes, initializers
• db → migrations, schema, seeds
• bin, vendor, public, storage, tmp, test → supporting files
• Architectural patterns: traditional Rails MVC, RESTful controllers, namespaced backoffice areas, asset pipeline, background jobs (app/jobs), ActionCable channels (real-time features), ActiveStorage for file handling.
README for additional insights
• Confirms use of SQLite3 (dev/test), ElasticSearch for search, Devise for user and admin authentication, Prawn for PDF export.
• No built-in API layer beyond standard Rails controllers (server-rendered views).
Elements
• Clear labels:
• “Browser (Public/User/Admin)”
• “Puma Web Server / Rails App”
• “Controllers (site, users_backoffice, admins_backoffice, ActionCable)”
• “Models / ActiveRecord”
• “Views / ERB + Asset Pipeline”
• “SQLite3 Database”
• “ElasticSearch Cluster”
• “SMTP Mail Server”
• “Storage Service (ActiveStorage)”
• HTTP request/response
• DB queries
• Search queries
• Email deliveries
• WebSocket messages
• Rectangles for application components
• Clouds for external services
Final advice
• Be exhaustive: break the Rails app into MVC, background jobs, channels, and asset pipeline.
• Every major integration (ElasticSearch, Mailer, ActiveStorage).
• Don’t overthink: more components (namespaces, gems, services) give a clearer view of responsibilities.