How elionay00/helpnow-solidarity-app-project works
Project Type and Purpose
• Type: Mobile-first/full-stack prototype front-end application (Ionic React + React Router + TypeScript)
• Purpose: “AjudaJá” connects users in need with volunteers via geolocated requests/offers, auth flows, and planned chat/map features.
File Structure
• Top-Level Configs:
• package.json, tsconfig.json, vite.config.ts → build and tooling (Vite + TS)
• ionic.config.json → Ionic CLI settings
• cypress.config.ts + cypress/… → end-to-end testing
• Public Assets:
• public/manifest.json, index.html → PWA web manifest and HTML shell
• Source Code (“src”):
• main.tsx → app bootstrap (Ionic React + Router)
• App.tsx + App.test.tsx → top‐level router/tab container and basic tests
• pages/ (Home.tsx) → core tab pages
• Autentication/ (Login.tsx, Register.tsx) → auth flow pages
• components/ExploreContainer.tsx → reusable UI component(s)
• utils/(masks.ts, validationSchemas.ts) → input masks & form validation
• theme/variables.css → theming variables
• Build & Linting:
• eslint.config.js, tsconfig.node.json
• Tests:
• cypress-based E2E, React Testing Library in setupTests.ts
Key Insights from README
• Navigation: IonTabs + IonRouterOutlet + React Router for bottom tab navigation (Home, Login, Register)
• Register page uses Yup schema, input masks, Ionic UI components
• Planned features: backend API, map (geolocation), chat, emergency button, NGO management panel
Main Components
a. Presentation Layer (Ionic React Front-end)
• Ionic UI Components (IonTabs, IonInput, IonButton, IonCard…)
• React Router (route definitions within IonRouterOutlet)
• Pages: Home, Login, Register
• Reusable Components: ExploreContainer, Input masks & validation services
b. Build & Delivery
• Vite bundler → Outputs PWA/SPA assets
• Cypress E2E & React unit tests
c. External Services (future/backlog)
• Authentication API (Sign-up, Login endpoints)
• Geolocation/Map API (Google Maps or OpenStreetMap)
• Chat Service (WebSocket or REST+Polling)
• Database (User profiles, requests/offers)
• Notification Service (push, emergency alerts)
d. Utility Modules
• Input mask service
• Validation schemas
Relationships & Interactions
• User taps a tab → React Router/Ionic RouterOutlet loads the corresponding Page component.
• Register/Login pages call Auth API → JSON over HTTPS → receives JWT/session token.
• Home page fetches geolocated data from Map API and app-specific REST endpoints.
• Components use common utils for validation and formatting before dispatching API calls.
• Build pipeline: Vite bundles src → static assets served to mobile/web platforms.
• Tests: Cypress drives the UI through the tab flow → validates end-to-end behavior.
Architectural Patterns & Principles
• Layered Architecture: Presentation (pages/components) → Domain logic (validation, auth services) → Data/Integration (external APIs)
• Component-based UI (Ionic + React)
• Client-side routing (React Router)
• Separation of concerns: utils vs UI vs pages
• Future extensibility for micro-frontend splits or hybrid mobile packaging