BizTech Documentation

Documenting BizTech's spaghetti code

Introduction

Introduction

Welcome to the BizTech documentation site; your central resource for understanding, using, and contributing to all BizTech codebases.

Getting Started

Set up your local dev environment and start contributing to BizTech projects.

Architecture Guide

Understand how our frontend and backend systems are structured.

API Reference

Explore every endpoint across our 19 microservices.

Page Builder

Create new documentation pages visually and submit them as pull requests.


Overview

This documentation site serves as the hub for all technical information related to BizTech development projects. Whether you're a new contributor, an organizer, or a returning developer, this site aims to make working with BizTech's code easy, efficient, and collaborative.

Here, you'll find guides, architecture breakdowns, API references, and more - covering everything from our internal tooling and infrastructure to event-specific apps and open-source initiatives.

Who This Is For

  • Contributors – Developers and designers working on BizTech projects looking for guidelines, best practices, and technical references.
  • Organizers – Team leads and directors needing to understand how to deploy, maintain, or extend BizTech systems.
  • Newcomers – Anyone interested in getting involved with BizTech development and learning how to get started.

What's Included

  • Project Overviews – Understand the purpose and scope of each BizTech project.
  • Setup Guides – Step-by-step instructions to help you get up and running in any repo.
  • Code Standards – Best practices and conventions we follow across our projects.
  • API References – Detailed documentation for our internal and public APIs.
  • Deployment Guides – Instructions for hosting and maintaining our tools and platforms.
  • Contribution Guidelines – How to contribute code, file issues, or request features.

Requirements

You’ll need basic familiarity with Git, JavaScript/TypeScript, and modern development tools. Each project may have its own specific dependencies - these will be outlined in the relevant sections.

All tools and platforms are accessible via modern web browsers. Make sure you’re using an up-to-date version of Chrome, Firefox, Safari, or Edge for best results.

Conclusion

BizTech is built on the efforts of a growing, collaborative community. This documentation is here to make it easier for everyone to contribute effectively, understand our systems, and build tools that support our mission. Dive in, explore, and if something’s unclear - contribute a fix!