Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 859 Bytes

README.md

File metadata and controls

31 lines (20 loc) · 859 Bytes

Flux documentation OpenAPI Specification

Flux

Links

Warning: All above links are updated only after Travis CI finishes deployment

Working on specification

Install

  1. Install Node JS
  2. Clone repo and run npm install in the repo root

Usage

npm start

Starts the development server.

npm run build

Bundles the spec and prepares web_deploy folder with static assets.

npm test

Validates the spec.

npm run gh-pages

Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured.