mirror of
https://github.com/Redocly/redoc.git
synced 2024-11-13 04:16:34 +03:00
Added run instructions
This commit is contained in:
parent
f4dfe92919
commit
624e2bfb2b
13
README.md
13
README.md
|
@ -7,3 +7,16 @@ Prototype of component-based Swagger documentation
|
||||||
**Under development**
|
**Under development**
|
||||||
|
|
||||||
[Live demo](http://romangotsiy.github.io/redoc-prototype/)
|
[Live demo](http://romangotsiy.github.io/redoc-prototype/)
|
||||||
|
|
||||||
|
## 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`
|
||||||
|
|
Loading…
Reference in New Issue
Block a user