From 3eb0f754f3074f0a492f4e0a86dd6aa47ba8910c Mon Sep 17 00:00:00 2001 From: Alexa Amundson Date: Mon, 9 Mar 2026 03:38:04 -0500 Subject: [PATCH] =?UTF-8?q?Rewrite=20README=20=E2=80=94=20clean=20table=20?= =?UTF-8?q?format,=20remove=20emoji=20spam?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit RoadChain-SHA2048: f1c3e1fc929efc25 RoadChain-Identity: alexa@sovereign RoadChain-Full: f1c3e1fc929efc25a6b17ecc6d11ef7328891b301726031c2003deb60387b28a9dce8ccd7caa7fb26208d4f2db5903333823d5d0227bfa4e30dc548ea86daf3f9aaf47bace8243f7d5320f36bd5c1e06167e20dec150961eb0c8cce84b711b7eae9859773c5750f02985ceaf34aa4d2b9731af51b0ebcd8707ac632a3d4d0a91a49e164cf9e2b094e9b81ba7aa580f641f0f12ad160530df59e477c427880466b518db4912756a6399d8d5020d1214045deffb4497889e7701efc2dc6857a4588e1b426e5ed99d222b50ea71ee9e9f4328f94965e47ca18737aceb486a710bef09e8b4ac41b045908a791d39ce9611bb5ccd6053945076ed002e653d0c60ab4b --- README.md | 151 ++++++++++++------------------------------------------ 1 file changed, 33 insertions(+), 118 deletions(-) diff --git a/README.md b/README.md index 43ac99b..87634f6 100644 --- a/README.md +++ b/README.md @@ -1,142 +1,57 @@ -# BlackRoad Ecosystem πŸ›£οΈ +# BlackRoad Apps -Complete suite of platforms for the BlackRoad operating system. +Application suite for the BlackRoad OS platform. 8 services spanning project management, streaming, blockchain, and infrastructure monitoring. ## Applications -### πŸ—ΊοΈ RoadMap -**Project Planning & Collaboration Platform** -- Tech: Next.js, TypeScript, WebSockets -- Features: Real-time collaboration, Kanban boards, Analytics -- Target: aria64 (Raspberry Pi) +| App | Stack | Description | +|-----|-------|-------------| +| **RoadMap** | Next.js, TypeScript, WebSockets | Project planning with real-time Kanban boards | +| **RoadWork** | Node.js, Express | Job board with AI matching | +| **RoadWorld** | Go, Gin, WebGL | Earth exploration and virtual environments | +| **RoadChain** | Rust, Actix-web, SHA-256 | Blockchain verification and immutable storage | +| **RoadCoin** | Python, FastAPI, Redis | Equity crowdfunding and crypto payments | +| **RoadView** | Node.js | Creative suite β€” design, video, AI generation | +| **PitStop** | Go, Gin | Infrastructure dashboard with real-time metrics | +| **RoadSide** | Node.js, Socket.io | Deployment portal and server connections | -### πŸ’Ό RoadWork -**Job Portal & Entrepreneur Platform** -- Tech: Node.js, Express, MongoDB simulation -- Features: Job board, AI matching, Entrepreneur networking, Funding connections -- Target: aria64 (Raspberry Pi) +## Deploy -### 🌍 RoadWorld -**Metaverse & Game Creation Platform** -- Tech: Go, Gin, WebSockets, WebGL -- Features: Open world Earth simulation, Virtual HQs, Game creation, 3D assets -- Target: shellfish (Droplet) - -### ⛓️ RoadChain -**Blockchain Verification System** -- Tech: Rust, Actix-web, SHA-256 -- Features: Immutable data storage, Proof of work, Transaction verification -- Target: shellfish (Droplet) - -### πŸ’° RoadCoin -**Non-IPO Funding Platform** -- Tech: Python, FastAPI, Redis -- Features: Equity crowdfunding, Crypto payments, Smart contracts -- Target: shellfish (Droplet) - -### 🎨 RoadView -**Creative Suite** -- Tech: Node.js (future: Vue.js + Python) -- Features: Design tools, Video editing, AI generation, YouTube integration -- Target: aria64 (Raspberry Pi) - -### πŸ”§ PitStop -**Infrastructure Dashboard** -- Tech: Go, Gin -- Features: Real-time metrics, Container management, DNS, Deployments -- Target: aria64 (Raspberry Pi) - -### 🚦 RoadSide -**Connections & Deploy Portal** -- Tech: Node.js, Socket.io -- Features: Server connections, Deployment UI, DNS config, CLI integration -- Target: aria64 (Raspberry Pi) - -## Quick Deploy - -Deploy all applications: ```bash -cd ~/blackroad-apps +# Deploy all ./DEPLOY_ALL.sh -``` -Deploy individual app: -```bash -cd ~/blackroad-deploy -./br-deploy deploy ~/blackroad-apps/roadmap aria64 +# Deploy one app +~/blackroad-deploy/br-deploy deploy ~/blackroad-apps/roadmap aria64 ``` ## Architecture -``` -β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” -β”‚ BlackRoad Ecosystem β”‚ -β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€ -β”‚ β”‚ -β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ -β”‚ β”‚ aria64 β”‚ β”‚shellfish β”‚ β”‚ -β”‚ β”‚ (Pi) β”‚ β”‚ (Droplet)β”‚ β”‚ -β”‚ β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”˜ β”‚ -β”‚ β”‚ β”‚ β”‚ -β”‚ β”Œβ”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β” β”‚ -β”‚ β”‚ Caddy Reverse Proxy β”‚ β”‚ -β”‚ └─────────┬───────────── β”˜ β”‚ -β”‚ β”‚ β”‚ -β”‚ β”Œβ”€β”€β”€β”€β–Όβ”€β”€β”€β”€β” β”‚ -β”‚ β”‚ Apps β”‚ β”‚ -β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ -β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ -``` +Apps run on Raspberry Pi nodes (aria64) and DigitalOcean droplets behind Caddy reverse proxy. -## Deployment Status - -Check deployments: ```bash +# Check deployments ~/blackroad-deploy/br-deploy list aria64 -~/blackroad-deploy/br-deploy list shellfish -``` -View logs: -```bash +# View logs ~/blackroad-deploy/br-deploy logs roadmap aria64 -~/blackroad-deploy/br-deploy logs roadworld shellfish ``` -## DNS Configuration +## Project Structure -Set up domains for each app: -```bash -~/blackroad-deploy/scripts/dns-manager.sh set roadmap.blackroad.io aria64 -~/blackroad-deploy/scripts/dns-manager.sh set roadwork.blackroad.io aria64 -~/blackroad-deploy/scripts/dns-manager.sh set roadworld.blackroad.io shellfish -~/blackroad-deploy/scripts/dns-manager.sh set roadchain.blackroad.io shellfish -~/blackroad-deploy/scripts/dns-manager.sh set roadcoin.blackroad.io shellfish -~/blackroad-deploy/scripts/dns-manager.sh set roadview.blackroad.io aria64 -~/blackroad-deploy/scripts/dns-manager.sh set pitstop.blackroad.io aria64 -~/blackroad-deploy/scripts/dns-manager.sh set roadside.blackroad.io aria64 +``` +blackroad-apps/ + roadmap/ # Project planning + roadwork/ # Job portal + roadworld/ # Earth exploration + roadchain/ # Blockchain + roadcoin/ # Crowdfunding + roadview/ # Creative suite + pitstop/ # Infrastructure dashboard + roadside/ # Deploy portal + DEPLOY_ALL.sh # Batch deploy script ``` -## Tech Stack Summary +## License -- **Frontend**: Next.js, React, Vue.js, Svelte -- **Backend**: Node.js, Python, Go, Rust -- **Real-time**: WebSockets, Socket.io -- **Data**: PostgreSQL, MongoDB, Redis -- **Blockchain**: Custom Rust implementation -- **3D/Graphics**: Three.js, WebGL -- **Deployment**: Docker, Custom buildpacks - -## Features Across Ecosystem - -βœ… Real-time collaboration -βœ… AI integration -βœ… Blockchain verification -βœ… Metaverse/3D worlds -βœ… Job matching -βœ… Funding platforms -βœ… Creative tools -βœ… Infrastructure monitoring - ---- - -Built for BlackRoad OS πŸ›£οΈ +Copyright 2026 BlackRoad OS, Inc. All rights reserved.