- Documentation(ReDoc): https://growobservatory.github.io/ThingfulNode/
- SwaggerUI: https://growobservatory.github.io/ThingfulNode/swagger-ui/
- Look full spec:
- Preview spec version for branch
[branch]
: https://growobservatory.github.io/ThingfulNode/preview/[branch]
- Install Node JS
- Clone repo and
cd
- Run
npm install
- Run
- Install Docker
- Build the Docker images
docker build -t thingful/grow-docs .
- Run the image
docker run --name thingful-grow-docs -v `pwd`:/src/app -p 3000:3000 -p 5000:5000 -d thingful/grow-docs
Shortcuts are available for make users. Run
make help
to see the available commands.
- Run
npm start
- Checkout console output to see where local server is started. You can use all links (except
preview
) by replacing https://growobservatory.github.io/ThingfulNode/ 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-ui
in 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 😄