Run Locally

See the Guide

Dev Lake is the one-stop solution that integrates, analyzes, and visualizes software development data throughout the software development life cycle (SDLC) for engineering teams.

1. Supports various data sources (Gitlab, Jira) and more are being added all the time
2. Relevant, customizable data metrics ready to view as visual charts
3. Easily build and view new charts and dashboards with Grafana
4. Easy-to-setup via Docker
5. Extensible plugin system to add your own data collectors
6. Designed to process enterprise-scale data

Below is a list of data source plugins used to collect & enrich data from specific sources. Each have a README.md file with basic setup, troubleshooting and metrics info.

For more information on building a new data source plugin see Build a Plugin.

We use Grafana as a visualization tool to build charts for the data stored in our database. Using SQL queries we can add panels to build, save, and edit customized dashboards.

All the details on provisioning, and customizing a dashboard can be found in the Grafana Doc

NOTE: If you only plan to run the product, this is the only section you should need NOTE: Commands written like this are to be run in your terminal

• Docker
• Node.js

NOTE: After installing docker, you may need to run the docker application and restart your terminal

1. Navigate to where you would like to install this project and clone the repository
   

   git clone https://github.com/merico-dev/lake.git
   cd lake

2. Install npm packages with npm install

3. Run the command npm run config to setup your configuration files

   For more info on how to configure plugins, please refer to the data source plugins section

4. Start the service by running the command npm start

   you can stop all docker containers with npm run stop

5. Run docker-compose -f docker-compose.yml -f docker-compose.prod.yml logs -f lake to check the logs and see when lake stops collecting your data. This can take up to 20 minutes for large projects. (gitlab 10k+ commits or jira 5k+ issues)

6. Navigate to Grafana Dashboard https://localhost:3002 (Username: admin, password: admin)

docs/DEVELOPER_SETUP.md

CONTRIBUTING.md

Message us on Discord