kyy/swagger-ui

Files

Fergus McDowall 81cc06f4f8 housekeeping: change git clone URL (#5612 )

When `git clone` -ing from github, `https` URLs are (as far as I know) functionally equivalent yet less error prone.

2019-09-26 19:47:29 -07:00

746 B

Raw Blame History

Setting up a dev environment

Swagger UI includes a development server that provides hot module reloading and unminified stack traces, for easier development.

Prerequisites

Node.js 6.0.0 or greater
npm 3.0.0 or greater
git, any version

Steps

git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
npm install
npm run dev
Wait a bit
Open http://localhost:3200/

Bonus points

Swagger UI includes an ESLint rule definition. If you use a graphical editor, consider installing an ESLint plugin, which will point out syntax and style errors for you as you code.
- The linter runs as part of the PR test sequence, so don’t think you can get away with not paying attention to it!