Google Git
Sign in
apache / incubator-devlake / refs/heads/javascript-mvp
commit6f95420249a3108a4a7c14fa37f8bb9498295213[log] [tgz]
authorHezheng Yin <hezheng@merico.dev>Fri Aug 20 10:45:05 2021 -0700
committerJonathan O'Donnell <joncodo@meri.co>Tue Aug 24 15:35:34 2021 -0300
tree7b53870568e0ad59de342ded6d2fbf1ad2c85d25
parenta3ec23bb5edbe1f124de67baa86649f01fb74262 [diff]
parent8a1df333dfba6a0e76bb10b4749aa3a60dcb36a7 [diff]
Merge pull request #263 from merico-dev/replace-screenshot

docs: update screenshots
tree: 7b53870568e0ad59de342ded6d2fbf1ad2c85d25
  1. .github/
  2. .husky/
  3. config/
  4. db/
  5. docs/
  6. grafana/
  7. scripts/
  8. src/
  9. test/
  10. .editorconfig
  11. .env.docker
  12. .eslintignore
  13. .eslintrc.json
  14. .gitignore
  15. .nvmrc
  16. .sequelizerc
  17. commitlint.config.js
  18. concurrently.js
  19. CONTRIBUTING.md
  20. docker-compose.prod.yml
  21. docker-compose.yml
  22. Dockerfile
  23. package-lock.json
  24. package.json
  25. rabbitmq.conf
  26. README.md
  27. run.sh
  28. simulate-new-setup.sh
README.md

Dev Lake

PRs Welcome Discord badge

What is Dev Lake?

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.

Why choose Dev Lake?

  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

Contents

SectionDescriptionDocumentation Link
RequirementsUnderlying software usedView Section
User SetupQuick and easy setupView Section
Data Source PluginsLinks to specific plugin usage & detailsView Section
Developer SetupSteps to get up and runningView Section
Build a PluginDetails on how to make your ownLink
Add Plugin MetricsGuide to adding plugin metricsLink
GrafanaHow to visualize the dataLink
ContributingHow to contribute to this repoLink

Data Sources We Currently Support

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.

SectionSection InfoDocs
JiraMetrics, Generating API Token, Find Project/Board IDLink
GitlabMetrics, Generating API TokenLink

Grafana

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

User Setup

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

Required Packages to Install

  • Docker
  • Node.js

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

Commands to run in 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

    To map a custom status for a plugin refer to /config/plugins.js
    Ex: In Jira, if you're using Rejected as a Bug type, refer to the statusMappings sections for issues mapped to “Bug”
    All statusMappings contain 2 objects. an open status (first object), and a closed status (second object)

  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)

Developer Setup

docs/DEVELOPER_SETUP.md

Contributing

CONTRIBUTING.md

Need help?

Message us on Discord