README.md

🐻 Berachain Monorepo Docs

This is a monolithic repository that contains all the documentation for Berachain, Berps, Bend, and BEX.

Requirements

• NVM or Node v20.11.0 or greater
• pnpm (recommended)

Turborepo Folder Structure

This Turborepo includes the following packages/apps:

Docs

All docs are built with Vitepress - Vite & Vue Powered Static Site Generator.

• apps/bend- Main docs repository for https://docs.bend.berachain.com
• apps/berps- Main docs repository for https://docs.berps.berachain.com
• apps/bex- Main docs repository for https://docs.bex.berachain.com
• apps/core- Main docs repository for https://docs.berachain.com

Packages

A series of packages that are shared with various apps (doc sites).

• packages/ui: All Vitepress vue components used by the different doc apps.
• packages/config: All configurations and constants

Quick Start

Install dependencies for all apps and packages.

# FROM: ./

pnpm install;

If you'd like to run all apps at the same time, run the following:

# FROM:  ./

pnpm dev;

# @berachain/bex:dev - http://localhost:5173
# @berachain/bend/:dev - http://localhost:5174
# @berachain/berps:dev - http://localhost:5175
# @berachain/core:dev - http://localhost:5176

If you'd like to run an individual app, run the following:

# FROM: ./

pnpm dev --filter @berachain/core;

Contributing

Code Of Conduct

Please see Code of Conduct.

Contributing Guide

Please see CONTRIBUTING.md on how to contribute and also see the development workflow.

License

Berachain Docs License