/zkBNB-docs

Primary LanguageJavaScriptMIT LicenseMIT

zkBNB Official Documentation

Overview

The zkBNB is an infrastructure for developers that helps them to build large scale BSC-based apps with higher throughput and much lower or even zero transaction fees. This is the GitHub repo of the official documentation and API refernce for zkBNB. This app is built using Docusaurus 2, a modern static website generator.

Prerequisites

  • Node version >= 14 or above

    • node -v
      • v16.13.0

  • npm --version

    • 8.1.0

  • Yarn _version >= 1.5 _

    • yarn --version
      • 1.22.17

How to Run Locally

Clone the reository and run the following commands.

Installing Dependencies

  • Install the packages.

Using npm

$ npm install

Using Yarn

$ yarn install
  • Start local development server

Using npm

$ npm run start

Using Yarn

$ 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

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

Using npm

$ npm run build

Using Yarn

$ yarn run build

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

Build and Serve locally

Using npm

$ npm run start

Using Yarn

$ yarn start

Serve Locally after build is created

Using npm

$ npm run serve

Using Yarn

$ yarn serve

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

Generating API docs

  • The following command will generate API docs for all of the OpenAPI specifications
yarn docusaurus gen-api-docs <id>
  • Generating API docs for 'zkbnb'
yarn docusaurus gen-api-docs zkbnb

Cleaning API docs

  • The following command will clean API docs for all of the OpenAPI specifications
yarn docusaurus clean-api-docs <id>
  • Generating API docs for 'zkbnb'
yarn docusaurus clean-api-docs zkbnb