This repository has been archived by the owner on Dec 1, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README-CN.md * Update README-CN.md * Update README-CN.md * Update README-CN.md * Update README-CN.md * Update README-CN.md * Update README-CN.md
- Loading branch information
1 parent
8855465
commit 2a20a70
Showing
2 changed files
with
66 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,39 +17,50 @@ | |
</a> | ||
</p> | ||
|
||
# Nebula Graph | ||
# Nebula Graph是什么? | ||
|
||
**Nebula Graph** 的目标是为超大规模图数据提供高并发,低延时的读、写及计算。**Nebula Graph** 是一个开源项目,我们期待与社区合作共同推广图数据库。 | ||
**Nebula Graph** 是一款开源的图数据库,擅长处理千亿个顶点和万亿条边的超大规模数据集。 | ||
|
||
**Nebula Graph** 的主要特点: | ||
与其他图数据库产品相比,**Nebula Graph** 具有如下优势: | ||
|
||
* 全对称分布式架构 | ||
* 可扩展 | ||
* 高可用 | ||
* 数据强一致 | ||
* 存储与计算分离 | ||
* 水平可扩展性 | ||
* RAFT 协议下的数据强一致 | ||
* 类 SQL 查询语言 | ||
* 用户鉴权 | ||
* 支持多存储后端 | ||
|
||
## 获取 Nebula Graph | ||
## 产品路线图 | ||
|
||
除编译源代码外,也可使用 [Nebula Graph 镜像](https://hub.docker.com/r/vesoft/nebula-graph) 进行试用。 | ||
更多详情参见 [Get Started](docs/manual-CN/1.overview/2.quick-start/1.get-started.md)。您也可以在这里访问 [详细文档](docs/manual-CN/README.md)。 | ||
**Nebula Graph** 产品规划路线图请参见 [roadmap](https://github.com/vesoft-inc/nebula/wiki#roadmap)。 | ||
|
||
## 使用 Nebula Graph | ||
## 快速使用 | ||
|
||
请查看[手册](docs/README.md)或下载 [pdf](https://nebula-graph.oss-cn-hangzhou.aliyuncs.com/doc/manual-en-1204.pdf)。 | ||
请查看[快速使用手册](docs/manual-CN/1.overview/2.quick-start/1.get-started.md),开始使用 **Nebula Graph**。 | ||
|
||
您也可以观看[视频](https://space.bilibili.com/472621355)开始学习 **Nebula Graph**。 | ||
在开始使用 **Nebula Graph** 之前,必须通过[编译源码](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/3.build-develop-and-administration/1.build/1.build-source-code.md)或者 [docker compose](https://github.com/vesoft-inc/nebula-docker-compose) 方式安装 **Nebula Graph**。您也可以观看[视频](https://space.bilibili.com/472621355)学习如何安装 **Nebula Graph**。 | ||
|
||
## 参与 Nebula Graph | ||
## 获取帮助 | ||
|
||
**Nebula Graph** 是一个完全开源的项目,欢迎开源爱好者参与 **Nebula Graph** 社区,目前有以下贡献方式: | ||
在使用 **Nebula Graph** 过程中遇到任何问题,都可以通过下面的方式寻求帮助: | ||
* [知乎](https://www.zhihu.com/org/nebulagraph/activities) | ||
* [SegmentFault](https://segmentfault.com/t/nebula) | ||
|
||
* 试用 **Nebula Graph** 并给出反馈 | ||
* 提交功能需求或者 issue | ||
## 文档 | ||
|
||
* [简体中文](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-CN/README.md) | ||
* [English](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/README.md) | ||
|
||
## Nebula Graph 产品架构图 | ||
|
||
![image](https://github.com/vesoft-inc/nebula-docs/raw/master/images/Nebula%20Arch.png) | ||
|
||
## 如何贡献 | ||
|
||
**Nebula Graph** 是一个完全开源的项目,欢迎开源爱好者通过以下方式参与到 **Nebula Graph** 社区: | ||
* 从标记为 [good first issues](https://github.com/vesoft-inc/nebula/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 的问题入手 | ||
* 贡献代码,详情请参见 [如何贡献](docs/manual-CN/4.contributions/how-to-contribute.md) | ||
* 帮助我们完善文档,详情参见 [贡献文档](docs/manual-CN/4.contributions/contribute-to-documentation.md) | ||
* 直接在GitHub上提 [Issue](https://github.com/vesoft-inc/nebula/issues) | ||
|
||
## 许可证 | ||
|
||
|
@@ -59,9 +70,7 @@ | |
|
||
## 联系方式 | ||
|
||
* 使用 [GitHub issue tracker](https://github.com/vesoft-inc/nebula/issues) 提交 issue 或功能需求。 | ||
* 访问官网 [Home Page](http://nebula-graph.io/)。 | ||
* [![WeiXin](https://img.shields.io/badge/WeChat-%E5%BE%AE%E4%BF%A1-brightgreen)](https://user-images.githubusercontent.com/38887077/67449282-4362b300-f64c-11e9-878f-7efc373e5e55.jpg) | ||
[![Zhihu](https://img.shields.io/badge/Zhihu-%E7%9F%A5%E4%B9%8E-blue)](https://www.zhihu.com/org/nebulagraph/activities) | ||
[![SegmentFault](https://img.shields.io/badge/SegmentFault-%E6%80%9D%E5%90%A6-green)](https://segmentfault.com/t/nebula) | ||
[![Sina Weibo](https://img.shields.io/badge/Weibo-%E5%BE%AE%E5%8D%9A-red)](https://weibo.com/p/1006067122684542/home?from=page_100606&mod=TAB#place) | ||
* [![Sina Weibo](https://img.shields.io/badge/Weibo-%E5%BE%AE%E5%8D%9A-red)](https://weibo.com/p/1006067122684542/home?from=page_100606&mod=TAB#place) | ||
* email: [email protected] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,9 @@ | ||
<p align="center"> | ||
<img src="docs/logo.png"/> | ||
<br> English | <a href="README-CN.md">中文</a> | ||
<br>A distributed, scalable, lighting-fast graph database<br> | ||
<br>A distributed, scalable, lightning-fast graph database<br> | ||
</p> | ||
<p align="center"> | ||
<a href="https://github.com/vesoft-inc/nebula/actions?workflow=build"> | ||
<img src="https://github.com/vesoft-inc/nebula/workflows/build/badge.svg" alt="build and test workflow"/> | ||
</a> | ||
|
@@ -20,42 +22,48 @@ | |
<br> | ||
</p> | ||
|
||
# Nebula Graph | ||
|
||
**Nebula Graph** is the only solution in the world capable of hosting graphs with dozens of billions of vertices (nodes) and trillions of edges, while still only having milliseconds of latency. | ||
# What is Nebula Graph? | ||
|
||
**Nebula Graph's** goal is to provide reading, writing, and computing with high concurrency and low latency for super large scale graphs. **Nebula Graph** is an open source project and we are looking forward to working with the community to popularize and promote the graph database. | ||
**Nebula Graph** is an open-source graph database capable of hosting super large scale graphs with dozens of billions of vertices (nodes) and trillions of edges, with milliseconds of latency. | ||
|
||
As a graph database, **Nebula Graph** has these features: | ||
Compared with other graph database solutions, **Nebula Graph** has the following advantages: | ||
|
||
* Symmetrically distributed | ||
* Highly scalable | ||
* Fault tolerant | ||
* Strong data consistency | ||
* Storage and computing separation | ||
* Horizontal scalability | ||
* Strong data consistency by RAFT protocol | ||
* SQL-like query language | ||
* Role-based access control | ||
* Support multiple storage engines | ||
* Role-based access control for higher level security | ||
|
||
## Roadmap | ||
|
||
See our [Roadmap](https://github.com/vesoft-inc/nebula/wiki#roadmap) for what's coming soon in **Nebula Graph**. | ||
|
||
## Quick start | ||
|
||
## How Can I Get Nebula Graph | ||
Read the [Getting started](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/1.overview/2.quick-start/1.get-started.md) article for a quick start. | ||
|
||
Apart from [installing from source code](docs/manual-EN/3.build-develop-and-administration/1.build/1.build-source-code.md), you can use the [docker image](https://hub.docker.com/r/vesoft/nebula-graph) and [develop](https://hub.docker.com/u/vesoft). | ||
Please note that you need to install **Nebula Graph**, either by [installing source code](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/3.build-develop-and-administration/1.build/1.build-source-code.md) or by [docker compose](https://github.com/vesoft-inc/nebula-docker-compose), before you can actually start using it. If you prefer a video tutorial, visit our [YouTube channel](https://www.youtube.com/watch?v=5RjCDKQvjk8&list=PL4ArMmsAnb84uB2d9L46eXpIi7Epz2cfp). | ||
|
||
## How to Use Nebula Graph | ||
## Getting help | ||
In case you encounter any problems playing around **Nebula Graph**, please reach out for help: | ||
* [Slack channel](https://nebulagraph.slack.com/archives/DJQC9P0H5/p1557815158000200) | ||
* [Stack Overflow](https://stackoverflow.com/questions/tagged/nebulagraph) | ||
|
||
See [manual](docs/README.md) or download the [pdf](https://nebula-graph.oss-cn-hangzhou.aliyuncs.com/doc/manual-en-1204.pdf). | ||
## Documentation | ||
|
||
You can also get started by watching [videos](https://www.youtube.com/channel/UC73V8q795eSEMxDX4Pvdwmw/). | ||
* [English](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-EN/README.md) | ||
* [简体中文](https://github.com/vesoft-inc/nebula/blob/master/docs/manual-CN/README.md) | ||
|
||
## How Can I Contribute | ||
## Architecture | ||
![image](https://github.com/vesoft-inc/nebula-docs/raw/master/images/Nebula%20Arch.png) | ||
|
||
As the team behind **Nebula Graph**, we fully commit to the community and all-in to the open source project. All the core features are and will be implemented in the open source repository. | ||
## Contributing | ||
|
||
We also encourage the community to be involved in the project. There are a few ways you can contribute: | ||
Contributions are warmly welcomed and greatly appreciated. And here are a few ways you can contribute: | ||
|
||
* You can download and try **Nebula Graph**, and provide us feedbacks | ||
* You can submit your feature requirements and bug reports | ||
* You can improve documentation | ||
* You can fix bugs or implement features. More details on how to build the project and submit the Pull Requests click [how-to-contribute](docs/manual-EN/4.contributions/how-to-contribute.md). | ||
* Start by some [good first issues](https://github.com/vesoft-inc/nebula/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) | ||
* Submit Pull Requests to us. See [how-to-contribute](docs/manual-EN/4.contributions/how-to-contribute.md). | ||
|
||
## Licensing | ||
|
||
|
@@ -65,5 +73,7 @@ In order to prevent cloud providers monetizing from the project without contribu | |
|
||
## Contact | ||
|
||
* Please use [GitHub issue tracker](https://github.com/vesoft-inc/nebula/issues) for filling bugs or feature requests. | ||
* Join [![](https://img.shields.io/badge/slack-nebula-519dd9.svg)](https://nebulagraph.slack.com/archives/DJQC9P0H5/p1557815158000200). | ||
* Twitter: <a href="https://twitter.com/NebulaGraph">@NebulaGraph</a> | ||
* <a href="https://www.linkedin.com/company/vesoft-nebula-graph/">LinkedIn page</a> | ||
* <a href="https://nebulagraph.slack.com/archives/DJQC9P0H5/p1557815158000200">Slack channel</a> | ||
* email: [email protected] |