The official web interface for the Aegis RWA Protocol. Built with Next.js, this dashboard provides a seamless UI for administrators to mint compliant Real-World Assets and for investors to manage their portfolios.
- Node.js (v18+)
- Freighter Wallet Browser Extension
- Clone the repository and install dependencies:
npm install- Run the development server:
npm run dev- Open http://localhost:3000 in your browser.
We welcome frontend contributions! Check CONTRIBUTING.md for our branching strategies and Tailwind styling rules. Look for // TODO: comments in the codebase for easy wins.
We welcome frontend contributions! Please read our Contributing Guide before submitting a pull request.
Key resources for contributors:
- Evaluation Readiness Dashboard — Central summary page for testing standards, CI workflow, PR evidence, acceptance criteria mapping, self-review, and payment guidance
- Contributing Guide — Branch naming, component rules, PR evidence checklist, and review process
- Evaluation-Readiness Index — Central page linking every requirement for GrantFox evaluation: payment expectations, testing standards, CI guidance, acceptance criteria audit, self-assessment, and reviewer checklist
- PR Evidence Checklist — Detailed requirements for pull request evidence and documentation
- Test-First Contribution Guide — How to write tests before code, with area-specific patterns and examples
- Aegis Dashboard Minimum Testing Standard — Minimum test coverage for admin workflows, investor views, compliance screens, asset registration, minting, wallet connection, and diagnostics
- Aegis SDK Testing Standard — Minimum unit, integration, and negative-path test coverage for compliance, KYC, RWA metadata, investor reads, admin actions, and transaction receipts
- Architecture Overview — Component hierarchy and state management
- Frontend Developer Guide — Styling conventions and page creation
- Compliance Reviewer Workflow — Guide for compliance operators reviewing investor eligibility
- Investor Transfer Request Flow — Request-validation edge cases (address, self-transfer, amount, precision) and RPC-failure handling for the transfer modal
- Compliance-Safe Wording Guidance — Canonical disclaimer text, typed helper, and reviewer checklist for compliance-facing copy
- Bulk Compliance Review — Bulk compliance review table with action confirmation modal
- Environment Mismatch Blocking Screen — Full-page blocking screen when the wallet network does not match the dashboard target network
- Investor Onboarding Eligibility — Investor onboarding eligibility page, evaluation precedence, and SDK mapping
Note: All pull requests must follow the PR Evidence Checklist and be audited against the Evaluation Readiness Dashboard before requesting review.
The transactions page also includes a contributor-ready fixture gallery for transaction review, progress, and receipt states. See docs/transaction-components.md for the shared component contract, fixture expectations, and compliance-safe wording guidance.
Before submitting a pull request for maintainer review or payment evaluation, review the Evaluation Readiness Dashboard. It links testing standards, CI status expectations, PR evidence templates, acceptance criteria mapping, and conduct guidelines into a single scorecard.
During GrantFox evaluation windows, all contributors must follow the Payment-Period Conduct Policy. Repeated spam, payout-related complaints, or harassment in community channels will not be tolerated. Self-review your PR thoroughly before raising payment concerns.
Role-aware route guards protect admin, issuer, investor, and read-only sections. See docs/route-access.md for route mapping, guard states, SDK assumptions, and mock wallet fixtures.
Before submitting a PR, read the Contribution Quality Examples for concrete examples of low-effort, partial, under-tested, failing-CI, and acceptable contributions — including what each category looks like and how to improve it. The companion Low-Effort PR Examples covers additional screenshot and CI-specific anti-patterns.
A full index of every file in docs/ organised by audience (onboarding, building features, review and payment, release) is at docs/README.md.