/opbnb-docs

Primary LanguageJavaScriptMIT LicenseMIT

opBNB Official Documentation

Overview

The opBNB network is the Layer 2 scaling solution for the BNB Smart Chain powered by bedrock version of Optimism opStack.

This is the GitHub repo of the official documentation for opBNB. This app is built using Docusaurus 2, a modern static website generator.

Prerequisites

  • Node version >= 16 or above

    • node -v
      • v16.14.0

  • Yarn _version >= 1.5 _

    • yarn --version
      • 1.22.19

How to Run Locally

Clone the reository and run the following commands.

Installing Dependencies

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

Build

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.

Build and Serve locally

$ yarn start

Serve Locally after build is created

$ yarn serve

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