Awesome Open Source
Awesome Open Source

Build Status

apidoc-ui

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

Preview

APIDOC-UI-org

APIDOC-UI-model

APIDOC-UI-resource

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

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

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (70,997
react (5,575
api (1,762
redux (1,183
apis (65
apidoc (18