Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-28 19:43:43 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added run instructions

Browse Source
This commit is contained in:
Roman Gotsiy 2015-10-11 21:33:13 +03:00
parent f4dfe92919
commit 624e2bfb2b
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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`