README-zh_CN.md

English | 简体中文

简介

LinDB 是一个高性能、高可用并且具备水平拓展性的开源分布式时序数据库。

• 主要特性
• 用户指南
• 快速开始
• 设计
• 架构
• Admin UI

编译

依赖

在本地编译 LinDB 需要以下工具：

• Go >=1.21
• Make tool
• Yarn

获取代码

git clone https://github.com/lindb/lindb.git
cd lindb

编译源代码

仅编译 LinDB 后端（无管理界面）

make build

同时编译 LinDB 前端与后端

make build-all

测试

make test

管理界面(开发者)

启动 LinDB 前端应用

cd web
yarn install
yarn dev

可以通过 localhost port 3000 来访问

架构

Admin UI

Some admin ui snapshots.

Overview

Monitoring Dashboard

Replication State

Data Explore

Explain

JAVA 版 LinDB 相关文章

• 数据分析之时序数据库
• 分布式时序数据库 - LinDB

贡献代码

我们非常期待有社区爱好者能加入我们一起参与开发，CONTRIBUTING 是一些简单的 PR 的规范，对于 一个 PR 中的多个 commit，我们会根据情况在合并时做 squash 并进行归类，以方便后续查看回溯。

CI

PR 应当带上合适的标签，并且关联到已有的 issue 上 issues。 所有的 PR 都会在 GITHUB-Actions 进行测试，社区贡献者需要关注 CI 的结果，对未通过的错误进行修复。

静态检查

我们使用了以下的检查器，所有代码都需要针对以下工具做一些调整。

• gofmt - Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification;
• golint - Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes;
• goimports - Goimports does everything that gofmt does. Additionally it checks unused imports;
• errcheck - Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases;
• gocyclo - Computes and checks the cyclomatic complexity of functions;
• maligned - Tool to detect Go structs that would take less memory if their fields were sorted;
• dupl - Tool for code clone detection;
• goconst - Finds repeated strings that could be replaced by a constant;
• gocritic - The most opinionated Go source code linter;

开源许可协议

LinDB 使用 Apache 2.0 协议， 点击 LICENSE 查看详情。