BNB Greenfield is an innovative blockchain and storage platform that seeks to unleash the power of decentralized technology on data ownership and the data economy. This is the GitHub repo of the official documentation and API refernce for BNB Greenfield. This app is built using Docusaurus 2, a modern static website generator.

• Node version >= 16 or above

  • node -v
    • v16.14.0

• Yarn _version >= 1.5 _

  • yarn --version
    • 1.22.19

Clone the reository and run the following commands.

• Install the packages.

$ yarn install

• Start local development server

$ 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.

We recommend to use the yarn package for building and deploying this website.

$ yarn build

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

$ yarn start 

$ yarn serve

The website is run locally on your default browser on http://localhost:3000.

• The following command will generate API docs for all of the OpenAPI specifications

yarn docusaurus gen-api-docs <id>

• Generating API docs for 'greenfield'

yarn docusaurus gen-api-docs greenfield

• The following command will clean API docs for all of the OpenAPI specifications

yarn docusaurus clean-api-docs <id>

• Generating API docs for 'greenfield'

yarn docusaurus clean-api-docs greenfield