Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 947 Bytes

README.md

File metadata and controls

31 lines (19 loc) · 947 Bytes
Raw

IMPORTANT: please make sure you install "git lfs" in order to use this repository.

This is a Vocs project bootstrapped with the Vocs CLI.

Dev

  1. Clone the repo and run pnpm i to install packages.
  2. Run a local environment with pnpm run dev.

In order to run the authentication, if needed, you will need to setup a cors-anywhere docker instance in order to proxy the request to the Builder API:

docker run -d -p 8080:8080 --dns 1.1.1.1 --name cors-anywhere redocly/cors-anywhere

Update openapi docs

When you update examples in any of the existing docs/pages/api/**/examples.json which updates openapi request/response examples.

You have to run this command to propagate those changes to openapi document.

pnpm run update-examples

In production, we leverage github actions to deploy a workflow and deploy automatically to github pages via the build branch.

v2 docs of Sequence Stack