docs: update root README for frontend implementation #27

[gabito1451]

Executive Summary

This PR updates the root [README.md]to reflect the transition into a monorepo structure that includes the new Next.js reference frontend. It provides contributors with immediate clarity on the repository layout, tech stack requirements (Next.js 16+, TypeScript, Tailwind), and streamlined local development setup procedures.

Linked Issues & References

• Issue: Resolves Update Repository README for Frontend Integration #28
• Related PRs: Initialize Type-Safe Next.js Frontend Application #27

Type of Change

Category

• New Feature (Non-breaking change adding functionality)
• Bug Fix (Non-breaking change fixing an issue)
• Performance Optimization (Code change to improve efficiency)
• Refactoring (Code structure change without external API modification)
• Security Patch (Fixing a vulnerability or security concern)
• Documentation (Updates to README, Wiki, or inline docs)
• Infrastructure (CI/CD, build scripts, Docker)

Domain

• Smart Contracts (Rust/Soroban)
• SDK/Backend (NestJS/TypeScript)
• Frontend/UI

Technical Implementation Details

• Architecture Refactor: Replaced legacy component links with an integrated view of the system, correctly identifying this repository as the hub for both documentation and the reference UI.
• Repository Structure: Added a visual directory tree highlighting the frontend/ directory (App Router, components, and lib) to establish clear project boundaries.
• Setup Guide: Authored a new "Frontend Setup" section under Quick Start, detailing dependency installation, environment variable configuration (.env.example usage), and development server commands.
• Route Documentation: Explicitly mapped the core functional pages (/, /send, /claim/[token]) to help new contributors navigate the codebase.
• Link Maintenance: Fixed a broken documentation link that previously pointed to a non-existent docs/README.md.

Breaking Changes

• No - Backward compatibility is maintained.
• Yes - This change requires consumers of the SDK/Contract to update their code.

Verification & Testing Strategy

Automated Tests

• Unit Tests: Added/Updated new unit tests.
• Integration Tests: Verified interaction between modules.
• Linting: Code follows the project's style guide (Markdown syntax verified).

Manual Verification

1. Environment:

• Target Environment: Local Markdown Preview / GitHub README Preview

2. Reproduction Steps:

1. Open the root README.md in a markdown renderer.
2. Verified that the Architecture section correctly identifies the Next.js 16+ stack.
3. Verified that the Repository Structure matches the implementation specifications for Issue Initialize Type-Safe Next.js Frontend Application #27.
4. Verified that Local Setup commands (cd, npm install, etc.) are accurate.

3. Proof of Execution:

• README.md updated successfully with zero broken links.

Quality Assurance Checklist

• I have performed a self-review of my own code.
• I have commented on my code, particularly in hard-to-understand areas.
• I have updated the documentation to reflect these changes.
• My changes do not generate new warnings or errors.
• I have verified that new dependencies are necessary and secure.
• (If Smart Contract) I have verified gas usage and storage footprints are optimized.

---

By submitting this Pull Request, I acknowledge that I have adhered to the Bridgelet contribution guidelines.

[phertyameen]

Awsome