How cristhian036/proyecto-herramientas-desarrollo works
Project Type and Purpose
• This is a full-stack web application (“Plataforma de Gestión y Difusión de la Municipalidad”) comprised of:
• A Spring Boot/JVM-based backend (sistema_municipal_backend)
• An Angular frontend (sistema_municipal_frontend)
• A relational database defined by bd.sql (base_datos_sistema_municipal)
• It provides citizen communication, transparency portals, participation forums with JWT-based authentication, role management, and notifications.
File Structure Overview
• Top-level directories:
• base_datos_sistema_municipal – SQL schema/data
• sistema_municipal_backend – Spring Boot service
• sistema_municipal_frontend – Angular SPA
• Backend layers (com.utp.sistema_municipal_backend):
• configuraciones – JWT, security filters/config
• controladores – REST controllers for auth & user/forum endpoints
• modelo – domain objects (Usuario, Rol, JwtRequest/Response)
• repositorios – Spring Data JPA interfaces
• servicios + impl – business logic & UserDetailsService
• Frontend modules (src/app):
• pages – home, login, signup, admin dashboard, user dashboard
• components – shared navbar
• services – HTTP clients (login.service, user.service), guards, interceptor
• environments – API URL settings
Key Insights from README
• Emphasis on user-generated forums, moderated discussion, notifications
• JWT authentication for registered users
• Clear separation between public info (news, alerts) and private forum area
Main Components
a. Frontend (Angular SPA)
• UI Components (pages, navbar)
• Angular Router & Guards (AdminGuard, NormalGuard)
• HTTP Interceptor (attaches JWT)
b. Backend (Spring Boot REST API)
• Security Layer (JwtAuthenticationFilter, JwtUtils, AuthenticationEntryPoint)
• Controllers (AuthenticationController, UsuarioController)
• Service Layer (UsuarioService, UserDetailsServiceImpl)
• Repository Layer (UsuarioRepository, RolRepository)
c. Database (SQL)
• Tables: users, roles, user_roles, forums, posts, notifications
– Defined in bd.sql
d. External/Infrastructure
• (Optional) Email/Notification Service
• Build tools: Gradle, npm
• Deployment env: Tomcat/embedded, Node
Relationships and Data Flows
• User → Frontend (login, navigate)
• Frontend → Backend (HTTP/JSON over REST):
• /auth/login, /auth/signup
• /users/** (profile, forums)
• /forums/** (create, post, fetch)
• Backend → Database (JPA/Hibernate): CRUD on entities
• JWT flows: user logs in → receives token → HTTP Interceptor adds token to subsequent calls → SecurityFilter validates token → grants access
Architectural Patterns & Principles
• Layered (Controller → Service → Repository)
• Stateless REST + JWT for authentication/authorization
• Angular modularity (feature modules, shared components)
• Dependency Injection throughout (Spring & Angular)
Technologies & Frameworks
• Frontend: Angular, TypeScript, RxJS, Angular Router, HTTPClient
• Backend: Spring Boot, Spring Security, Spring Data JPA, JWT, Gradle
• Database: MySQL/PostgreSQL (schema in bd.sql)
• Tools: Git, Maven wrapper/Gradle wrapper, npm, Karma/Jasmine tests
Final Recommendations
• Every layer—don’t just show “Backend,” break it into Security, Controllers, Services, Repos
• Keep labels concise but precise; include method names for key interactions if space allows
• Iterate: review with the team to ensure no component is missing or misrepresented