https://github.com/bx-team/website
Official website for BX Team
https://github.com/bx-team/website
bun fumadocs mdx nextjs nodejs react tailwindcss typescript
Last synced: 7 months ago
JSON representation
Official website for BX Team
- Host: GitHub
- URL: https://github.com/bx-team/website
- Owner: BX-Team
- License: mit
- Created: 2025-02-03T23:25:20.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-03-06T16:55:59.000Z (7 months ago)
- Last Synced: 2025-03-06T17:24:39.530Z (7 months ago)
- Topics: bun, fumadocs, mdx, nextjs, nodejs, react, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://bxteam.org
- Size: 1.7 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# BX Team Website [](https://discord.gg/p7cxhw7E2M) [](https://app.netlify.com/sites/bx-team-website/deploys)
This repository contains the source code for the main BX Team website, including the documentation pages. Website is published at [bxteam.org](https://bxteam.org).
## Getting Started
How to get docs running on your local machine for development.
### Prerequisites
- [node](https://nodejs.org)
- [bun](https://bun.sh/)
### Local Development
1. Clone the repository. If you plan to make changes, create a fork first!
```bash
$ git clone https://github.com/BX-Team/website
```
2. Install all required dependencies.
```bash
$ bun install
```
3. Start the development server.
```bash
$ 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
```bash
$ bun run build
```
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.