devlake

(β˜… 3,106)

Apache DevLake is an open-source dev data platform to ingest, analyze, and visualize the fragmented data from DevOps tools, extracting insights for engineering excellence, developer experience, and community growth.

Showing a partial file list β€” download the zip above to see everything.

  • .asf.yaml
  • .codespellrc
  • .dockerignore
  • .editorconfig
  • .gitattributes
  • .gitignore
  • .licenserc.yaml
  • AGENTS.md
  • DISCLAIMER
  • LICENSE
  • Makefile
  • NOTICE
  • README.md

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/apache/devlake

Downloads the entire project code from GitHub to your computer.

cd devlake

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f backend/Dockerfile -t devlake .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 devlake

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Go

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Go The Go compiler and toolchain.
cd backend

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

βœ… If the build finishes without errors, it worked. If you used go run ., check the terminal output.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation