brevity / reducks-yaml-ui

A generic browser-based ui to facilitate api development/documentation

WIP: Move along please.

reducks-yaml-ui

A generic browser-based ui to facilitate api development/documentation

Todo

• Setup bones

  • [ ]

  • Demo link

  • Playground

  • Usage

  • License

  • Contribution

    • Contact info
    • Bounty/compensation? :
    • Requirements
      • inspiration
      • mockup
      • existing components
      • desired states/fixtures

  • Notes Notes

---

File Structure: tbd

./
 |-- index.js # echo 'module.exports = require('./dist/SAlert');'
 |-- dist/
 |   |-- bundle.css
 |   |-- ExampleHOC.js
 |-- demo/
 |   |-- index.html
 |   |-- bundle.js
 |   |-- bundle.css
 |-- src/
 |   |-- components/
 |   |   |-- __fixtures__/
 |   |   |-- main.js
 |   |-- libs/
 |-- static/
 |   |-- whatever.svg

Should be it's own repo, ready to delegate.

Should Have a README w/ the following sections

npm run scripts:
  - post-install: 
  - build: 
  - playground: 'cosmos run' # start the cosomos dev server
  - demo: 'cosmosbuild' #Should kick out a static package w/ functional component and mocked states

Decide... Settle

file structure

discussion in github issue medium article

Carry On

product

• yaml-ui First step in a generic service ui js-yaml