Skip to content

docs: add component README entry points #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
snowrugar-beep merged 1 commit into from
Jul 17, 2026
Merged

docs: add component README entry points #199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 3 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,5 @@
# VertexChain: Location-Aware Micro-Messaging on Stellar
# VertexChain

## Overview
VertexChain is an open, decentralized platform for anonymous, hyperlocal communication. Users can post short, geotagged messages ("gists") anchored to precise real-world coordinates, enabling local discovery of crowd-sourced tips, alerts, and conversations.
VertexChain is a location-aware micro-messaging platform built on Stellar. The frontend provides the map-based experience, the NestJS backend serves and indexes nearby gists, Soroban contracts anchor verifiable records on-chain, and the infrastructure layer packages and deploys the system. Together, these components support short geotagged messages with optional Stellar identity, IPFS-backed content, and fast local discovery.

## Architecture
VertexChain bridges Web2 and Web3 through a hybrid stack:
- **Frontend / Client Layer**: A geospatial web and mobile interface built using standard Web2 frameworks (React, Mapbox, Leaflet). Users interact with a map-based UI that supports real-time gist retrieval and posting.
- **Backend / API Layer**: A scalable indexer that handles location queries and data caching, backed by a lightweight RESTful API. Cached data improves performance and supports offline queries.
- **Blockchain Layer (Stellar Network)**:
- Gists are published as tokenized data objects using Stellar's smart contracts (Soroban).
- Each gist's metadata hash and location reference are stored immutably on-chain for data integrity, verifiability, and censorship resistance.
- Stellar's low-latency consensus and minimal transaction costs allow for near-instant anchoring of posts and edits.
- Native Stellar assets can be integrated for staking, moderation incentives, and reputation systems.

## Key Features
- Anonymous posting with optional cryptographic verification via Stellar addresses
- Immutable gist records with hash-linked permanence
- Smart contract enforcement of spatial access rules (visibility radius, cooldown periods, etc.)
- Off-chain storage bridging for larger data payloads via IPFS or Arweave with on-chain references
- Secure micropayments and tipping between local contributors using Stellar assets

## Why Stellar
Stellar provides the ideal foundation for VertexChain's decentralized locality engine due to its:
- High throughput and low fees — facilitating scalable community interactions
- Soroban smart contract layer, enabling composable logic for content governance
- Interoperability with other Web3 ecosystems via Stellar's cross-chain capabilities
Read the [Backend README](Backend/README.md) / [Frontend README](Frontend/README.md) / [Contracts README](contracts/README.md) / [Infrastructure README](infrastructure/README.md).
Loading