Skip to content

added architecture overview#648

Merged
Aditya948351 merged 2 commits into
devpathindcommunity-india:masterfrom
arpit2006:docs/architecture
Jun 17, 2026
Merged

added architecture overview#648
Aditya948351 merged 2 commits into
devpathindcommunity-india:masterfrom
arpit2006:docs/architecture

Conversation

@arpit2006

@arpit2006 arpit2006 commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Description

Closes: #603
Reference: #603

Added a comprehensive ARCHITECTURE.md file at the root of the project to outline the system architecture, folder structures, component dependencies, and design patterns utilized in the DevPath India Community Platform.

Key details included:

  • System Architecture Flow: High-level Mermaid diagram mapping client browser, Next.js context/hooks, Firebase services, the Express assistant server, and third-party integrations (OpenRouter & GitHub).
  • Client-Side Architecture: Detailed page routing tree, context managers description, and client state sequences.
  • Backend Architecture: Explanation of the Express.js route orchestration and LLM multi-model failover/retry hierarchy.
  • Database & Security: Outline of Firestore collections, schema relations, and access rules.
  • Gamification & Points Sync Pipeline: Explanatory diagram showing GitHub sync and XP calculation criteria.

Type of change

  • This change requires a documentation update

How Has This Been Tested?

  • Local testing (verified Mermaid diagrams rendering syntax)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings or errors
  • I have checked that the "DevPath India" branding remains intact

Signed-off-by: arpit2006 <arpitshirbhate25@gmail.com>
@arpit2006

Copy link
Copy Markdown
Contributor Author

@Aditya948351 , Requesting Review!

Signed-off-by: arpit2006 <arpitshirbhate25@gmail.com>
@arpit2006

Copy link
Copy Markdown
Contributor Author

The build/test failures are unrelated to the additions in ARCHITECTURE.md. They are caused by Playwright strict-mode locator violations in the existing E2E tests:


⚠️ Note on E2E Test Failures

The build/test failures are unrelated to the additions in ARCHITECTURE.md. They are caused by Playwright strict-mode locator violations in the existing E2E tests:

  1. Login Test Failure (shows error alert when submitting invalid credentials):

    • Reason: page.locator('[role="alert"]') now matches two elements on the screen: the actual login error banner and the default Next.js __next-route-announcer__ div.
    • Suggested Fix: Target the error alert specifically, for example:
      const errorAlert = page.locator('div[role="alert"]').first(); 
      // or target by container class / excluding the route announcer:
      const errorAlert = page.locator('div[role="alert"]:not([id="__next-route-announcer__"])');
  2. Roadmap Navigation Test Failures (learning paths page shows the h1 heading & "Back to Paths"):

    • Reason: page.getByRole('heading', { name: /learning paths/i }) matches both the <h1>Learning Paths</h1> title and the <h2>Structured Learning Paths</h2> subtitle.
    • Suggested Fix: Make the locator exact or specify the heading level:
      page.getByRole('heading', { name: 'Learning Paths', exact: true })
      // or
      page.getByRole('heading', { name: /learning paths/i, level: 1 })

@Aditya948351 Aditya948351 merged commit 3472654 into devpathindcommunity-india:master Jun 17, 2026
3 of 4 checks passed
@arpit2006

Copy link
Copy Markdown
Contributor Author

@Aditya948351 , Can you add Appropriate Label!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add architecture.md Documentation

2 participants