How leomssilva/ediaristas works
Project type and purpose
• This is a React/Next.js single-page application (with server-side rendering via Next.js) built in TypeScript.
• Purpose: allow end users to search for and view “diaristas” (cleaning professionals) in their city, displaying user information, search results, and contextual feedback.
File structure
• Top-level config and metadata:
• package.json, tsconfig.json, next-env.d.ts
• public/ – static assets (fonts, images)
• Source code under src/:
• src/pages/ – Next.js routing (SSR pages, _app.tsx wrapper, index.tsx)
• src/data/ – data/types/hooks/services
– @types/UserInterface.ts – data models
– hooks/pages/useIndex.ts – custom hook for index page data fetching
– services/ApiService.ts – HTTP client abstraction (Axios)
– services/ValidationService.ts – business-rule validation
• src/ui/ – presentational layer
– components/ – component library organized by concern:
· data-display (PageTitle, UserInformation)
· feedback (SafeEnvironment)
· inputs (TextField, TextFieldMask)
· surfaces (Header, Footer)
– styles/ – global CSS, per-page styles, theme definitions (theme.ts)
README for additional insights
• Confirms tech stack: Next.js, React, TypeScript, Material-UI, react-input-mask, Axios.
Main components
a. Client Layer (Browser)
– Renders UI, executes React code, either CSR or SSR from Next.js.
b. Next.js Server / Runtime
– Provides SSR entrypoint via pages/_app.tsx and pages/index.tsx.
c. Data Layer
– React hooks under src/data/hooks -> controls data fetching & state.
d. Service Layer
– ApiService (wraps Axios) calls external REST API to fetch diaristas and user info.
– ValidationService handles front-end validations.
e. UI Layer
– Atomic/presentational components (TextField, PageTitle, Header, Footer, etc.)
– Styles (CSS modules, theme)
f. External Services
– Third-party API endpoint (hosted separately) that returns diarista data.
g. Static Assets
– Fonts and images served from public/
Relationships and interactions
• User (Browser) ➔ navigates to Next.js page (index.tsx)
• Next.js SSR/runtime loads the page ➔ invokes custom hook useIndex
• useIndex ➔ calls ApiService.fetch(...) ➔ sends HTTP request to External API
• External API ➔ returns JSON ➔ ApiService resolves promise ➔ hook updates state
• index.tsx ➔ passes data to UI components (UserInformation, PageTitle, SafeEnvironment, etc.)
• UI components read theme & styles, render DOM
• Browser displays final UI; user interactions (e.g., form input) ➔ ValidationService on input events
• Static assets (fonts, images) loaded by Browser from public/
Architectural patterns and design principles
• Layered architecture: separation of concerns between UI, data, and services
• Component-based UI driven by React/Material-UI
• Custom React hooks for data orchestration
• Service abstraction (ApiService) decouples HTTP details from UI logic
• File organization follows feature grouping and Next.js conventions