An open API service indexing awesome lists of open source software.

https://github.com/bitquery/streaming-data-platform-docs

Documentation on the streaming data platform
https://github.com/bitquery/streaming-data-platform-docs

Last synced: 5 days ago
JSON representation

Documentation on the streaming data platform

Awesome Lists containing this project

README

          

# Bitquery Data Platform Documentation

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ export NODE_OPTIONS=--max_old_space_size=16000
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER= yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

### Generate PDF

```
yarn build

yarn serve

npx docusaurus-prince-pdf -u http://localhost:3000/docs/intro

```

### Contributing to Docs

Read contribution guidlines [here](https://docs.bitquery.io/docs/contribution_guidelines)