estela Documentation

Requirements

You should have installed Ruby with the specified version inside the .ruby_version file.

Build and run locally

Install Bundler and Jekyll (if you haven't)

$ gem install bundler jekyll

Install Redoc CLI (if you haven't)

$ yarn global add redoc-cli@0.13.16

Install the gems if it's the first time you build the project

$ bundle install

Build the swagger specification

$ redoc-cli build ../estela-api/docs/api.yaml -t ./assets/swagger-template.hbs --options.hideDownloadButton -o ./estela/api/endpoints.html

Then, build and run the site

$ bundle exec jekyll serve

By default, the site runs in the localhost and is built in a new folder named _site.