- Install Node JS
- Clone repo and
cd- Run
npm install
- Run
- Run
npm start - Checkout console output to see where local server is started. You can use all links (except
preview) by replacing https://github.com/valitydev/docs.git with url from the message:Server started <url> - Make changes using your favorite editor or
swagger-editor(look for URL in console output) - All changes are immediately propagated to your local server, moreover all documentation pages will be automagically refreshed in a browser after each change
TIP: you can open
swagger-editor, documentation andswagger-uiin parallel - Once you finish with the changes you can run tests using:
npm test - Share you changes with the rest of the world by pushing to GitHub 😄