BX Team Website

This repository contains the source code for the main BX Team website, including the documentation pages. Website is published at bxteam.org.

Getting Started

How to get docs running on your local machine for development.

Prerequisites

• node
• bun

Local Development

1. Clone the repository. If you plan to make changes, create a fork first!

$ git clone https://github.com/BX-Team/website

2. Install all required dependencies.

$ bun install

3. Start the development server.

$ bun dev

This will start a local development server and show you a link to local website. The majority of changes will be instantly reflected live without the need to restart the development server or reload the page in your browser. Edit away!

Building

$ bun run build

Contributing

Please read CONTRIBUTING.md for details on how to contribute to this project.