Skip to content

README.md

Latest commit

 

History

History
25 lines (16 loc) · 649 Bytes

README.md

File metadata and controls

25 lines (16 loc) · 649 Bytes

FluxOS API Documentation

Beautiful, interactive API documentation for FluxOS. Test against https://api.runonflux.io.

Quick Start

npm install
npm start

Visit http://localhost:4000 - Modern Redocly v2 interface with interactive testing.

Commands

  • npm start - Start interactive documentation server
  • npm run build - Generate static HTML for GitHub Pages
  • npm test - Lint OpenAPI specification
  • npm run docker - Run in Docker container

Deployment

GitHub Pages: Push to master, GitHub Actions will deploy automatically.

Your Server: Run npm start or npm run docker for containerized deployment.