Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 996 Bytes

README.md

File metadata and controls

23 lines (18 loc) · 996 Bytes
Raw

Hexlink React Client

OpenAPI Definition

  • The API is specified in the git repository [1] The repo is configured as a git submodule.
  • prism-cli is used to spin up a mock backend server: [2]

Steps

  1. git submodule sync will pull the schema, for now just use main/head
  2. yarn install will pull prism-cli
  3. yarn run server will run the hexlink mock backend
  4. You should now be able to make http requests
  5. Enjoy front end development

OpenAPI: Types & Client

yarn install will pull openapi-typescript & openapi-typescript-codegen OR yarn add openapi-typescript openapi-typescript-codegen --dev You need to be able to access the openapi binary on path so you might need to do yarn global add open-api-typescript openapi-typescript-codegen

References:

[1] Hexlink Schema: https://github.com/nevzheng/hexlink-schema [2] Prism: https://github.com/stoplightio/prism#readme [3] Walkthrough: https://blog.logrocket.com/generating-integrating-openapi-services-react/