Skip to content

OpenTelecom/kazoo

Repository files navigation

README

1. About This Repository

This repository is a hard fork of the original 2600hz/kazoo project.

The upstream repository has not seen meaningful updates since 2024-02, and functionally has not evolved in a significant way since 2020-05. This fork exists to:

  • Continue active development
  • Modernize the build and runtime environment
  • Incorporate community-driven improvements
  • Maintain long-term viability of the platform

This project stands on the shoulders of substantial community work. We would like to explicitly acknowledge and thank the maintainers and contributors of the following repositories (in no particular order):

This repository incorporates ideas, fixes, structural improvements, and lessons learned from across that ecosystem.

We are deeply appreciative of the work that has come before and the people who have kept the project alive in various forms.


2. Running the Project

Development Target

The current development target environment is:

  • Erlang/OTP 27
  • macOS

Development should still be possible on other platforms, but macOS is the primary and tested development environment at this time.


Requirements

You will need the following installed:

  • Erlang/OTP 27, installed via Homebrew
    • Homebrew is required specifically because of WX dependencies
  • Xcode Command Line Tools
  • Visual Studio Code
  • Erlang Language Server (VS Code extension)
  • Docker Desktop

Setup & Running

  1. Clone this repository.

  2. Open the project in VS Code.

  3. Select the launch configuration: "Start Kazoo"

  4. Run the configuration.

This launch configuration will:

  • Start required Docker components
  • Build the project inside the development environment
  • Attach the debugger automatically

Once attached, you should have a fully functional development environment suitable for stepping through code and active development.


3. Contributing

High Barrier to Entry (Initial Phase)

This project is currently in an early, infrastructure-focused phase.

At this stage:

  • There will be no releases
  • There will be no distributed binaries
  • There will be no packaged distributions
  • There will be no end-user support

Collaboration will initially be limited to contributors who:

  • Can independently set up the development environment
  • Can build and run the system without assistance
  • Are comfortable working directly with Erlang/OTP 27 and Docker

In other words, contributors must be fully self-sufficient.

This constraint exists purely due to extremely limited resources.


Language Policy

During this early phase:

  • Communication, collaboration, and contributions will be conducted in English only
  • The only exception is contributions specifically related to localization or translation

This is not a philosophical position --- it is a practical limitation due to resource constraints.


Closing Notes

This fork exists to ensure continued evolution of the Kazoo platform and to consolidate fragmented community improvements into a cohesive, actively maintained codebase.

If you are capable of running and extending the system independently and want to help move it forward, we welcome your contributions.