How jaykava/sso-server works
Project type and purpose
• This is a Ruby on Rails full-stack web application that acts as an OAuth 2.0 provider and user management system.
• It uses Devise for user authentication, custom controllers for OAuth client registration and token flows, Stimulus (via importmap) for minimal JavaScript interactivity, Action Cable for real-time channels, and Active Job/Mailers for background tasks and email notifications.
File structure
• Top-level Ruby/Rails standard layout:
• app/controllers, app/models, app/views → MVC pattern
• app/assets & app/javascript → asset pipeline + Stimulus controllers
• app/channels → real-time features via Action Cable
• app/mailers, app/jobs → background processing and email
• config/ holds environment configs, routes, cable (WebSocket), and Puma (app server).
• db/ has migrations for users, OAuth clients, access grants.
• Bin, Rakefile, Dockerfile → build/deploy scripts.
• Test/ covers unit, integration, system tests.
• Uses importmap (no Webpack) and Jbuilder for JSON endpoints.
README
• Placeholder README; no architecture details. We infer architecture entirely from file tree.
Detail checklist
• Controller cluster (AuthController, OAuthClientsController, DashboardController).
• Devise workflow: Sign-up, Sign-in, Password reset via mailers.
• Jbuilder rendering JSON for API consumers.
• Environment/deployment aspects if relevant (Docker → Puma).
• Don’t overcrowd: group related internals (e.g., all app/models) but call out domain models.