Skip to content

Add docs and Fix bun lock error#6

Merged
mors119 merged 1 commit into
FrilLab:mainfrom
mors119:fix/github_actions_error
Jun 10, 2026
Merged

Add docs and Fix bun lock error#6
mors119 merged 1 commit into
FrilLab:mainfrom
mors119:fix/github_actions_error

Conversation

@mors119

@mors119 mors119 commented Jun 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

Add docs and Fix bun lock error and Remove security.yml

Changes

  • add docs
  • remove security.yml
  • bun install

Summary by CodeRabbit

  • Documentation
    • Added system architecture documentation detailing component design and interactions.
    • Added product roadmap documentation outlining planned features and development phases.

@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 81950a0d-3d2b-4ef1-ae56-5b578bbfe6ac

📥 Commits

Reviewing files that changed from the base of the PR and between c4a66e1 and 47baee0.

⛔ Files ignored due to path filters (1)
  • apps/web/bun.lock is excluded by !**/*.lock
📒 Files selected for processing (3)
  • .github/workflows/security.yml
  • docs/ARCHITECTURE.md
  • docs/ROADMAP.md

📝 Walkthrough

Walkthrough

This PR removes a security workflow and introduces architecture and roadmap documentation. The architecture document outlines FrilChain's system design across Web, API, and Indexer services with planned communication flows. The roadmap defines a five-phase evolution from lightweight wallet explorer to a scalable blockchain data platform.

Changes

Documentation and Planning

Layer / File(s) Summary
Architecture Overview
docs/ARCHITECTURE.md
FrilChain architecture defined: Web client connects to Spring Boot API; data flows through Postgres, Redis Pub/Sub, and Rust JSON-RPC to blockchain nodes. Services documented with responsibilities and technologies. Communication mechanisms specified (REST, JSON-RPC, WebSocket, Redis Pub/Sub, planned Kafka). Early-phase database schema includes users, oauth_accounts, watchlists. Phased evolution outlined from wallet explorer to blockchain data platform.
Product Roadmap
docs/ROADMAP.md
Five-phase product roadmap documented: Phase 1 covers wallet balances, ERC20 lookups, history, OAuth, watchlists; Phase 2 adds portfolio management and caching; Phase 3 enables real-time notifications via WebSocket/SSE; Phase 4 introduces selective wallet indexing with Rust service; Phase 5 scales to event-driven platform with Kafka and multi-chain support.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes


Poem

🐰 A workflow takes leave, docs bloom in its place,
Architecture and roadmap map the builder's base,
Five phases unfold—from explorer to scale,
The blockchain awaits, may FrilChain prevail! 🌿

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@mors119 mors119 merged commit f98118f into FrilLab:main Jun 10, 2026
1 of 2 checks passed
@mors119 mors119 deleted the fix/github_actions_error branch June 10, 2026 01:42
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.

1 participant