Regenerate orchestrator README (#87)
## Summary - regenerate the orchestrator README with the latest `pnpm br-orchestrate render` output so it mirrors `orchestra.yml` ## Testing - not run (not requested) ------ [Codex Task](https://chatgpt.com/codex/tasks/task_e_693f600ae0f8832984b7e7a2e494239b)
This commit is contained in:
88
README.md
88
README.md
@@ -1,91 +1,3 @@
|
|||||||
# BlackRoad OS
|
|
||||||
|
|
||||||
> 🧠 **Org Brain & Map 🧭** – top-level nerve center for the entire BlackRoad OS constellation.
|
|
||||||
>
|
|
||||||
> 📖 **New here?** Start with [REPO_PERSONA.md](./REPO_PERSONA.md) to understand this repo's role and navigate the ecosystem.
|
|
||||||
|
|
||||||
A microservice infrastructure management platform for the BlackRoad ecosystem.
|
|
||||||
|
|
||||||
## Service Purpose
|
|
||||||
|
|
||||||
BlackRoad OS provides:
|
|
||||||
- Health monitoring endpoints
|
|
||||||
- Version tracking and build information
|
|
||||||
- Express and Fastify-based API routing
|
|
||||||
- Job scheduling with BullMQ
|
|
||||||
- React component library for UI dashboards
|
|
||||||
|
|
||||||
## Local Development
|
|
||||||
|
|
||||||
### Prerequisites
|
|
||||||
- Node.js 18+
|
|
||||||
- npm
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
### Running the Development Server
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run dev
|
|
||||||
```
|
|
||||||
|
|
||||||
The server will start at `http://localhost:8080`.
|
|
||||||
|
|
||||||
### Running Tests
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm test
|
|
||||||
```
|
|
||||||
|
|
||||||
## Build & Deploy
|
|
||||||
|
|
||||||
### Building for Production
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
This compiles TypeScript to JavaScript in the `dist/` directory.
|
|
||||||
|
|
||||||
### Running in Production
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
### Railway Deployment
|
|
||||||
|
|
||||||
This project is configured for automatic deployment on Railway. The `railway.toml` file defines:
|
|
||||||
|
|
||||||
- **Builder**: Nixpacks
|
|
||||||
- **Start Command**: `npm run start`
|
|
||||||
- **Healthcheck**: `/health` endpoint
|
|
||||||
- **Default Port**: 8080
|
|
||||||
|
|
||||||
## Healthcheck
|
|
||||||
|
|
||||||
The `/health` endpoint returns:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"status": "ok",
|
|
||||||
"service": "blackroad-os"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Environment Variables
|
|
||||||
|
|
||||||
| Variable | Description | Default |
|
|
||||||
|----------|-------------|---------|
|
|
||||||
| `PORT` | Server port | `8080` |
|
|
||||||
| `SERVICE_NAME` | Service identifier | `blackroad-os` |
|
|
||||||
| `ENVIRONMENT` | Runtime environment | `production` |
|
|
||||||
| `APP_VERSION` | Application version | `1.0.0` |
|
|
||||||
| `APP_COMMIT` | Git commit hash | Auto-detected |
|
|
||||||
# BlackRoad OS · Orchestrator
|
# BlackRoad OS · Orchestrator
|
||||||
|
|
||||||
Welcome to the meta-orchestration layer for the BlackRoad ecosystem. This repository
|
Welcome to the meta-orchestration layer for the BlackRoad ecosystem. This repository
|
||||||
|
|||||||
Reference in New Issue
Block a user