search

open-horizon / exchange-api

Horizon Exchange REST API Server
Apache License 2.0
11 stars 30 forks source link

Add Exchange-API quick start document #723

Closed omordyk closed 1 month ago

omordyk commented 1 month ago

Add Exchange-API quick start document. Description: This document describes the environment and the set of steps aiming to create a local development and debugging environment.

johnwalicki commented 1 month ago

Great installation page. If the goal will be to move this under the Open Horizon documentation website, it should complement the existing page (which has some of these instructions already) https://open-horizon.github.io/docs/exchange-api/docs/README/

omordyk commented 1 month ago

@johnwalicki Initial idea was to create a small guide for newcomers. I summarize my steps for preparing local development environment. If it is necessary I can move these steps in main Readme.

johnwalicki commented 1 month ago

I like the QuickStart.md doc in your PR. It contains additional details which are not in the main README.md Some overlap however.

We should ask @joewxboy to also review. We could merge these details into the README.md, accept this PR with its duplication, or split the Exchange API doc into an Installation guide (adding your details) and a Run/Tips/Docker guide.

joewxboy commented 1 month ago

@johnwalicki and @naphelps if no objections, how about merging then polishing as a separate task?

naphelps commented 1 month ago

No Objections.