development.md

Development Guide

Welcome! This guide will help you set up your local development environment for SigNoz. Let's get you started! 🚀

What do I need?

Before diving in, make sure you have these tools installed:

• Git - Our version control system

  • Download from git-scm.com

• Go - Powers our backend

  • Download from go.dev/dl
  • Check go.mod for the minimum version

• GCC - Required for CGO dependencies

  • Download from gcc.gnu.org

• Node - Powers our frontend

  • Download from nodejs.org
  • Check .nvmrc for the version

• Yarn - Our frontend package manager

  • Follow the installation guide

• Docker - For running Clickhouse and Postgres locally

  • Get it from docs.docker.com/get-docker

💡 Tip: Run make help to see all available commands with descriptions

How do I get the code?

1. Open your terminal
2. Clone the repository:

   git clone https://github.com/SigNoz/signoz.git

3. Navigate to the project:

   cd signoz

How do I run it locally?

SigNoz has three main components: Clickhouse, Backend, and Frontend. Let's set them up one by one.

1. Setting up Clickhouse

First, we need to get Clickhouse running:

make devenv-clickhouse

This command:

• Starts Clickhouse in a single-shard, single-replica cluster
• Sets up Zookeeper
• Runs the latest schema migrations

2. Starting the Backend

1. Run the backend server:

   make go-run-community

2. Verify it's working:

   curl http://localhost:8080/api/v1/health

   You should see: {"status":"ok"}

💡 Tip: The API server runs at http://localhost:8080/ by default

3. Setting up the Frontend

1. Install dependencies:

   yarn install

2. Create a .env file in the frontend directory:

   FRONTEND_API_ENDPOINT=http://localhost:8080

3. Start the development server:

   yarn dev

💡 Tip: yarn dev will automatically rebuild when you make changes to the code

Now you're all set to start developing! Happy coding! 🎉