- Docker v19.03.10+
- Golang v1.17+
- Mac (Already installed)
- Windows: Download
sudo apt-get install build-essential libssl-dev
How to setup dev environment
Navigate to where you would like to install this project and clone the repository:
git clone https://github.com/apache/incubator-devlake
Install dependencies for plugins:
Install Go packages
Copy the sample config file to new local file:
cp .env.example .env
Update the following variables in the file
Start the MySQL and Grafana containers:
Make sure the Docker daemon is running before this step.
docker-compose up -d mysql grafana
Run lake and config UI in dev mode in two separate terminals:
# install mockery
go install github.com/vektra/mockery/v2@latest
# generate mocking stubs
# run lake
# run config UI
Q: I got an error saying:
libgit2.so.1.3: cannot open share object file: No such file or directory
A: Make sure your program can find
LD_LIBRARY_PATHcan be assigned like this if your
libgit2.so.1.3is located at
Visit config UI at
localhost:4000to configure data connections.
- Please follow the tutorial
- Submit the form to update the values by clicking on the Save Connection button on each form page
localhost:4000/pipelines/createto RUN a Pipeline and trigger data collection.
Pipelines Runs can be initiated by the new "Create Run" Interface. Simply enable the Data Connection Providers you wish to run collection for, and specify the data you want to collect, for instance, Project ID for Gitlab and Repository Name for GitHub.
Once a valid pipeline configuration has been created, press Create Run to start/run the pipeline. After the pipeline starts, you will be automatically redirected to the Pipeline Activity screen to monitor collection activity.
Pipelines is accessible from the main menu of the config-ui for easy access.
Manage All Pipelines:
Create Pipeline RUN:
Track Pipeline Activity:
For advanced use cases and complex pipelines, please use the Raw JSON API to manually initiate a run using cURL or graphical API tool such as Postman.
POSTthe following request to the DevLake API Endpoint.
Please refer to Pipeline Advanced Mode for in-depth explanation.
Click View Dashboards button in the top left when done, or visit
All the details on provisioning and customizing a dashboard can be found in the Grafana Doc.
(Optional) To run the tests:
For DB migrations, please refer to Migration Doc.