Skip to content

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 

Repository files navigation

onion-platform

Project Purpose

The onion-platform repository is the runnable, end‑to‑end application that integrates all libraries and services of the FLATLINEDSTAR ecosystem. It provides an HTTP API, a web dashboard, background workers, and deployment configuration (Docker, Helm, etc.).

Current Status

Planning – placeholder README only.

Why It Exists

Separating the platform (deployment, orchestration, UI) from the core libraries (onion-sdk, onion-intelligence, etc.) enables independent evolution of the service layer and easier packaging for users.

Architecture Role

  • Application – imports every other component as libraries.
  • Exposes REST/GraphQL endpoints for external clients.
  • Runs background workers that schedule periodic scans, monitor drift, and trigger alerts.
  • Bundles the CLI (onion-cli) for local usage and the API server for cloud deployments.

Planned Features (MVP)

  1. API server (Go + Echo/Fiber) exposing scan orchestration endpoints.
  2. Dockerfile and Helm chart for containerised deployment.
  3. Simple React/Next.js dashboard (leveraging the web UI from OnionScan).
  4. Configuration via YAML / environment variables (Tor address, DB path, rate limits).

Installation / Usage (placeholder)

# Build the platform binary
go build -o onion-platform ./cmd/platform

# Run with default config (requires a running Tor instance)
./onion-platform --config config.yaml

Will be available after MVP release.

Development

  • Language: Go (primary backend) with optional TypeScript front‑end.
  • Follow organization‑wide contribution guidelines.

Testing

  • Unit tests for each API handler.
  • End‑to‑end integration tests using Docker Compose (Tor, SQLite, API).

Contributing

See the organization‑wide CONTRIBUTING.md under .github.

Roadmap

  • Phase 1 – Scaffold the server, define OpenAPI spec, integrate SDK.
  • Phase 2 – Add dashboard UI and background worker framework.
  • Phase 3 – Harden security, implement rate‑limiting, CI/CD pipelines.

Relationship to FLATLINEDSTAR Ecosystem

onion-platform is the flagship runnable product; it consumes onion-intelligence (core reasoning) and all upstream libraries. The onion-cli can also invoke platform services directly.

License

MIT – see LICENSE in the repository root.

About

No description, website, or topics provided.

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors