2015-10-03 16:17:19 +03:00
|
|
|
# ReDoc prototype
|
|
|
|
|
|
|
|
|
|
[](https://travis-ci.org/RomanGotsiy/redoc-prototype)
|
|
|
|
|
|
|
|
|
|
Prototype of component-based Swagger documentation
|
|
|
|
|
|
|
|
|
|
**Under development**
|
|
|
|
|
|
|
|
|
|
[Live demo](http://romangotsiy.github.io/redoc-prototype/)
|
2015-10-11 21:33:13 +03:00
|
|
|
|
|
|
|
|
## Running locally
|
|
|
|
|
|
|
|
|
|
1. Clone repository
|
|
|
|
|
`git clone https://github.com/RomanGotsiy/redoc-prototype.git`
|
|
|
|
|
2. Go to the project folder
|
|
|
|
|
`cd redoc-prototype`
|
|
|
|
|
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`
|
