2015-10-30 15:53:02 +03:00
|
|
|
# ReDoc
|
2015-12-24 15:47:26 +03:00
|
|
|
[![travis-ci-status]](https://travis-ci.org/Rebilly/ReDoc) [![coverage-status-badge]](https://coveralls.io/github/Rebilly/ReDoc?branch=master) [![code-climate-badge]](https://codeclimate.com/github/Rebilly/ReDoc) [![dev-dependency-badge]](https://david-dm.org/Rebilly/ReDoc#info=devDependencies) [![license-badge]](https://github.com/Rebilly/ReDoc/blob/master/LICENSE)
|
2015-11-14 19:43:07 +03:00
|
|
|
|
2015-10-30 15:53:02 +03:00
|
|
|
Swagger-generated API Reference Documentation
|
2015-11-14 19:43:07 +03:00
|
|
|
|
|
|
|
|
**Under development**
|
2015-12-03 00:56:07 +03:00
|
|
|
|
2015-11-14 19:43:07 +03:00
|
|
|
[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`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[travis-ci-status]: https://travis-ci.org/Rebilly/ReDoc.svg?branch=master "TravisCI Status"
|
2015-11-16 02:29:33 +03:00
|
|
|
[license-badge]: https://img.shields.io/github/license/rebilly/redoc.svg "Github license"
|
2015-12-13 13:56:29 +03:00
|
|
|
[coverage-status-badge]:https://coveralls.io/repos/Rebilly/ReDoc/badge.svg?branch=master&service=github) "Coverage Status"
|
2015-12-19 23:21:17 +03:00
|
|
|
[dev-dependency-badge]: https://david-dm.org/Rebilly/ReDoc/dev-status.svg
|
2015-12-24 15:47:26 +03:00
|
|
|
[code-climate-badge]: https://codeclimate.com/github/Rebilly/ReDoc/badges/gpa.svg "Code Climate"
|
2015-11-14 19:43:07 +03:00
|
|
|
[demo]: http://rebilly.github.io/ReDoc/
|
