Hummingbot Client Documentation

This repository is documentation for the Hummingbot trading bot client, whose github repo can be found here.

The deployed version of this documentation is available at:

https://docs.hummingbot.io/

gatsby-theme-apollo-docs

This site uses gatsby-theme-apollo-docs.

Install required dependencies

Setup

`.env`

If you are going to build and update site indexing for Algolia, you will need to save the env-template file as .env locally and populate the variable values. Currently, we only use environment values for Algolia search.

node

Node versions this repo has been successfully been run and tested with: 10.22.1, 12.19.0

Running

yarn install to install dependencies
yarn start to launch local server
Open a browser to the link provided in the console

Deploy previews

Each pull request will be built and available for preview on netlify. To access the preview, look for the link in the status checks of the pull request.

Push changes to your branch
Create a pull request
Click Details next to "deploy/netlify Deploy preview ready!" from the pull request

Deployment

This site uses Algolia search which requires the environment variables from env-template.

Troubleshooting

Gatsby and react often results in conflicts. If you have errors running npm start or gatsby develop:

you may need to try to uninstall and reinstall react, react-dom, and gatsby (reference)
you can also try yarn install instead of npm install

Contributions

When contributing, please review the contributing guidelines

Component Guides

When editing markdown pages, please review the list of available components in Component Guide

Note: Use master as base branch

CoinAlpha/hummingbot-docs