Reorganizing the repository for better understanding

[ShrutiiNaidu]

Overview

The repository has grown significantly, and several files and folders are located at the root level, making navigation difficult for contributors. Reorganizing the project structure will improve readability, maintainability, and the overall developer experience.

Current Issues

• Multiple documentation files clutter the repository root.
• Project-related documents are not grouped into a dedicated folder.
• Configuration files and documentation are mixed together.
• New contributors may find it difficult to locate important files.
• The overall project structure can be made more consistent and scalable.

Proposed Changes

• Move documentation files (e.g., architecture.md, api-contracts.md, CAMPAIGN_COUNTERS_CACHE.md) into a dedicated docs/ directory.
• Keep only essential files in the root directory:
  • README.md
  • LICENSE
  • .gitignore
  • backend/
  • frontend/
  • .github/
• Organize configuration files logically.
• Update all documentation links after moving files.
• Ensure the README reflects the new project structure.

Expected Outcome

• Cleaner repository structure.
• Easier navigation for contributors.
• Improved maintainability.
• Better onboarding experience for new developers.
• A more professional and industry-standard project organization.

Acceptance Criteria

• Documentation moved to docs/
• README links updated
• No broken references
• Root directory contains only essential project files
• Project builds and runs successfully after reorganization

[aaniya22]

please assign this to me under gssoc'26

[shivanimishra2006]

Hi! I'd like to work on this issue. Could you please assign it to me? Thanks!

[aaniya22]

pls assign this to me under gssoc