mirror of
https://github.com/blackboxprogramming/BlackRoad-Operating-System.git
synced 2026-03-17 05:57:21 -05:00
e84407660d
Implements complete Phase 2 scaffold across 6 core modules: ## New Modules ### 1. Backend API Enhancements - Add system router with /version, /config/public, /os/state endpoints - Register system router in main.py - Add comprehensive tests for system endpoints ### 2. Core OS Runtime (core_os/) - Implement UserSession, Window, OSState models - Add state management functions (open_window, close_window, etc.) - Create Backend API adapter for communication - Include full test suite for models and state ### 3. Operator Engine (operator_engine/) - Build job registry with example jobs - Implement simple scheduler with lifecycle management - Optional HTTP server on port 8001 - Complete tests for jobs and scheduler ### 4. Web Client Enhancements - Add CoreOSClient JavaScript class - Integrate system API endpoints - Event-driven architecture for state updates - Zero dependencies, vanilla JavaScript ### 5. Prism Console (prism-console/) - Modern dark-themed admin UI - Multi-tab navigation (Overview, Jobs, Agents, Logs, System) - Real-time metrics dashboard - Backend API integration with auto-refresh ### 6. Documentation (codex-docs/) - Complete MkDocs-based documentation - Architecture guides and component docs - Infrastructure setup guides - API reference documentation ## CI/CD - Add core-os-tests.yml workflow - Add operator-tests.yml workflow - Add docs-build.yml workflow ## Documentation - Create BLACKROAD_OS_REPO_MAP.md cross-reference - Add README for each module - Comprehensive integration documentation ## Summary - 37 new files created - ~3,500 lines of new code - 5 test suites with 15+ tests - 3 new CI workflows - 10+ documentation pages All modules are minimal working skeletons ready for integration. Designed to be extracted into separate repos if needed. Phase 2 scaffold complete and ready for review.
96 lines
3.3 KiB
Markdown
96 lines
3.3 KiB
Markdown
# Welcome to BlackRoad OS Codex
|
|
|
|
> **Version:** 0.1.0 (Phase 2 Scaffold)
|
|
> **Last Updated:** 2025-11-18
|
|
|
|
## What is BlackRoad OS?
|
|
|
|
BlackRoad OS is a nostalgic Windows 95-inspired web-based operating system that brings together AI orchestration, blockchain technology, social media, video streaming, and gaming into a unified ecosystem.
|
|
|
|
## Key Features
|
|
|
|
- **🪟 Windows 95 UI** - Nostalgic desktop experience in your browser
|
|
- **🤖 208 AI Agents** - Autonomous agents across 10 categories
|
|
- **⛓️ RoadChain** - Tamper-evident blockchain ledger
|
|
- **⚡ Prism Console** - Admin and observability dashboard
|
|
- **🧠 Lucidia Layer** - Multi-model AI orchestration (Phase 2)
|
|
- **🌍 MetaCity** - Virtual worlds and experiences (Phase 3)
|
|
|
|
## Architecture Overview
|
|
|
|
BlackRoad OS is built on a 7-layer architecture:
|
|
|
|
```
|
|
Layer 7: User Experience (Domains & Landing Pages)
|
|
Layer 6: Application Layer (Pocket OS, Native Apps)
|
|
Layer 5: API Gateway & Routing (FastAPI)
|
|
Layer 4: Orchestration & Intelligence (Lucidia, Prism, Operator)
|
|
Layer 3: Data & State (PostgreSQL, Redis, RoadChain, Vault)
|
|
Layer 2: Compute & Infrastructure (Railway, DigitalOcean, Cloudflare Workers)
|
|
Layer 1: DNS & CDN (Cloudflare)
|
|
```
|
|
|
|
## Quick Links
|
|
|
|
- **[Architecture Guide](architecture.md)** - Understand the system design
|
|
- **[Components Overview](components.md)** - Explore each module
|
|
- **[Getting Started](dev/getting-started.md)** - Start developing
|
|
- **[API Reference](api/system.md)** - Explore the API
|
|
|
|
## Phase 2 Scaffold Status
|
|
|
|
| Module | Status | Description |
|
|
|--------|--------|-------------|
|
|
| Backend API | ✅ Complete | FastAPI with system endpoints |
|
|
| Core OS Runtime | ✅ Complete | State management and models |
|
|
| Operator Engine | ✅ Complete | Job scheduling and orchestration |
|
|
| Web Client | ✅ Enhanced | Pocket OS with Core OS client |
|
|
| Prism Console | ✅ Complete | Admin dashboard UI |
|
|
| Documentation | ✅ Complete | MkDocs-based Codex |
|
|
|
|
## Repository Structure
|
|
|
|
```
|
|
BlackRoad-Operating-System/
|
|
├── backend/ # FastAPI backend
|
|
├── core_os/ # Core OS runtime (NEW)
|
|
├── operator_engine/ # Operator engine (NEW)
|
|
├── prism-console/ # Prism admin UI (NEW)
|
|
├── web-client/ # Web client docs (NEW)
|
|
├── codex-docs/ # This documentation (NEW)
|
|
├── agents/ # 208 AI agents
|
|
├── docs/ # Legacy docs
|
|
└── README.md
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
1. **Explore the Architecture** - Read the [Architecture Guide](architecture.md)
|
|
2. **Set Up Locally** - Follow the [Local Setup Guide](dev/local-setup.md)
|
|
3. **Review Modules** - Understand each [Component](components.md)
|
|
4. **Try the API** - Check out the [API Reference](api/system.md)
|
|
|
|
## Vision
|
|
|
|
The ultimate goal is to create a complete AI-powered operating system that enables:
|
|
|
|
- **Create** - Content, code, and creative works
|
|
- **Build** - Infrastructure and applications
|
|
- **Operate** - Automated workflows and agents
|
|
- **Trade** - Digital assets and tokens
|
|
- **Govern** - Decentralized decision-making
|
|
- **Dream** - Virtual worlds and experiences
|
|
- **Explore** - Research and innovation
|
|
|
|
## Contributing
|
|
|
|
See the [Contributing Guide](dev/contributing.md) to learn how to contribute to BlackRoad OS.
|
|
|
|
## License
|
|
|
|
BlackRoad Operating System is licensed under the MIT License.
|
|
|
|
---
|
|
|
|
**Built with ❤️ by the BlackRoad OS Team**
|