[![Build Status](https://travis-ci.org/revenuewire/jackfruit-redoc.svg?branch=master)](https://travis-ci.org/revenuewire/jackfruit-redoc)

This API does not represent the final product. Some of the APIs listed below are highly experimental and will likely change before the final release. They may come with crashes and bugs and may potentially cause data loss.

## Links

- Documentation(ReDoc): https://revenuewire.github.io/jackfruit-redoc/
- SwaggerUI: https://revenuewire.github.io/jackfruit-redoc/swagger-ui/
- Look full spec:
    + JSON https://revenuewire.github.io/jackfruit-redoc/swagger.json
    + YAML https://revenuewire.github.io/jackfruit-redoc/swagger.yaml
- Preview spec version for branch `[branch]`: https://revenuewire.github.io/jackfruit-redoc/preview/[branch]

**Warning:** All above links are updated only after Travis CI finishes deployment

## Working on specification
### Install

1. Install [Node JS](https://nodejs.org/)
2. Clone repo and `cd`
    + Run `npm install`

### Usage

1. Run `npm start`
2. Checkout console output to see where local server is started. You can use all [links](#links) (except `preview`) by replacing https://revenuewire.github.io/jackfruit-redoc/ with url from the message: `Server started <url>`
3. Make changes using your favorite editor or `swagger-editor` (look for URL in console output)
4. 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 and `swagger-ui` in parallel
5. Once you finish with the changes you can run tests using: `npm test`
6. Share you changes with the rest of the world by pushing to GitHub :smile:
