Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-30 20:43:42 +03:00
Code Issues Packages Projects Releases Wiki Activity
2c284f585c
redoc/README.md
Roman Hotsiy f85a4afa43 Add codeclimate badge
2015-12-24 14:50:08 +02:00

1.2 KiB
Raw Blame History

ReDoc

travis-ci-status ![coverage-status-badge] ![code-climate-badge] ![dev-dependency-badge] license-badge

Swagger-generated API Reference Documentation

Under development

[Live demo][demo]

Running locally

  1. Clone repository git clone https://github.com/Rebilly/ReDoc.git
  2. Go to the project folder cd ReDoc
  3. Install node modules npm install
  4. (optional) Replace demo/swagger.json with your own schema
  5. Start the server npm start
  6. Open http://localhost:9000

[coverage-status-badge]:https://coveralls.io/repos/Rebilly/ReDoc/badge.svg?branch=master&service=github) "Coverage Status" [dev-dependency-badge]: https://david-dm.org/Rebilly/ReDoc/dev-status.svg [code-climate-badge]: https://codeclimate.com/github/Rebilly/ReDoc/badges/gpa.svg "Code Climate" [demo]: http://rebilly.github.io/ReDoc/