mirror of
https://github.com/Redocly/redoc.git
synced 2025-03-19 17:24:13 +03:00
25 lines
1.3 KiB
Markdown
25 lines
1.3 KiB
Markdown
# ReDoc
|
|
[](https://travis-ci.org/Rebilly/ReDoc) [](https://coveralls.io/github/Rebilly/ReDoc?branch=master) [](https://codeclimate.com/github/Rebilly/ReDoc) [](https://david-dm.org/Rebilly/ReDoc#info=devDependencies)
|
|
|
|
[](https://www.npmjs.com/package/swagger-parser) [](http://bower.io/) [](https://github.com/Rebilly/ReDoc/blob/master/LICENSE)
|
|
|
|
[](https://saucelabs.com/u/redoc)
|
|
|
|
Swagger-generated API Reference Documentation
|
|
|
|
**Under development**
|
|
|
|
[Live demo](http://rebilly.github.io/ReDoc/)
|
|
|
|
## 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`
|