apidoc-ui

A fresh UI built using React + Redux for https://github.com/mbryzek/apidoc

Preview

Dev

UI Dev

yarn install
yarn start
http://localhost:8080/

yarn test
yarn flow

Before a Pull Request

yarn run check

App

yarn start

Deploy

Deploy will build and push to S3. You need to have ~/.aws/credentials setup with access to the S3 bucket for this

yarn deploy

Build Settings

APIDOC_HOST

• Location of the apidoc api, examples:
  • http://somehost.com/api
  • /custom-api-route

PREFIX

• prefix for js and css assets. Defaults to /
  • /assets

TITLE

• The default title is APIDOC, this can be customized for a deployment
• If specified this removes the github icon and link

Example:

> APIDOC_HOST='/my-api' PREFIX='/assets' TITLE='My Company' yarn build