BX Team Website

This monorepo contains the source code for BX Team projects:

• Website - Main website with documentation, published at bxteam.org
• Atlas - API service for project builds and downloads

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.

For Website:

$ bun website:dev

For Atlas:

$ bun atlas:dev

This will start a local development server and show you a link to local application. 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

Build Website:

$ bun website:build

Build Atlas:

$ bun atlas:build

For production deployment, we use docker images. See Dockerfile in each project folder for more details.

Contributing

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