Skip to content
This repository has been archived by the owner on Jul 28, 2019. It is now read-only.

Latest commit

 

History

History
22 lines (14 loc) · 486 Bytes

README.md

File metadata and controls

22 lines (14 loc) · 486 Bytes

Resources API OpenAPI Specification

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.