Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #703

Merged
merged 1 commit into from
Sep 9, 2021
Merged

Update README.md #703

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 2 additions & 82 deletions docs-1.1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,84 +1,4 @@
> This version is depricated.

> !!! Note: Nebula Graph 1.x is not actively maintained. Please move to Nebula Graph [2.x](https://docs.nebula-graph.io/).
> The data format, rpc protocals are not compatible.

# What is Nebula Graph

**Nebula Graph** is an open-source graph database capable of hosting super large-scale graphs with billions of vertices (nodes) and trillions of edges, with milliseconds of latency. It delivers enterprise-grade high performance to simplify the most complex data sets imaginable into meaningful and useful information.

Below is the architecture of **Nebula Graph**:

![image](https://github.com/vesoft-inc/nebula-docs/raw/master/images/Nebula%20Arch.png)

Compared with other graph database solutions, **Nebula Graph** has the following advantages:

* Symmetrically distributed
* Storage and computing separation
* Horizontal scalability
* Strong data consistency by RAFT protocol
* SQL-like query language
* Role-based access control for higher level security

## [Video Tutorials](https://www.youtube.com/channel/UC73V8q795eSEMxDX4Pvdwmw)

If you prefer learning Nebula Graph by watching videos, go to our [YouTube Channel](https://www.youtube.com/channel/UC73V8q795eSEMxDX4Pvdwmw). At present, we have two series for you:

* [Getting started with Nebula Graph](https://www.youtube.com/playlist?list=PL4ArMmsAnb84uB2d9L46eXpIi7Epz2cfp)
* [Nebula Graph studio](https://www.youtube.com/playlist?list=PL4ArMmsAnb86R2MfUKFjzTQizCZCrhu2p)

## [Quick start](manual-EN/1.overview/2.quick-start/1.get-started.md)

Read the [Getting started](manual-EN/1.overview/2.quick-start/1.get-started.md) guide to quickly get going with **Nebula Graph**.

Please note that you must install **Nebula Graph** by [installing source code](https://docs.nebula-graph.io/manual-EN/3.build-develop-and-administration/1.build/1.build-source-code/), [rpm/deb packages](https://docs.nebula-graph.io/manual-EN/3.build-develop-and-administration/2.install/1.install-with-rpm-deb/) or [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/channel/UC73V8q795eSEMxDX4Pvdwmw).

If you have any questions, please don't hesitate to contact us on [forum](https://discuss.nebula-graph.io).

## FAQ

* [Explanations on the Time Return in Queries](manual-EN/1.overview/2.quick-start/2.FAQ.md)
* [About HDD and Gigabit Networks](https://docs.nebula-graph.io/manual-EN/3.build-develop-and-administration/3.configurations/0.system-requirement/#about_hdd_and_gigabit_networks)

## Documentation

* [English](https://docs.nebula-graph.io/)
* [简体中文](https://docs.nebula-graph.com.cn/)

## Roadmap

See our [Roadmap](https://github.com/vesoft-inc/nebula/wiki/Nebula-Graph-Roadmap-2020) for what's coming soon in **Nebula Graph**.

## Visualization Tool: Nebula Graph Studio

Visit [Nebula Graph Studio](https://github.com/vesoft-inc/nebula-web-docker) for visual exploration of graph data on a web UI.

## Supported Clients

* [Go](https://github.com/vesoft-inc/nebula-go)
* [Python](https://github.com/vesoft-inc/nebula-python)
* [Java](https://github.com/vesoft-inc/nebula-java)

## Licensing

**Nebula Graph** is under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license. So you can freely download, modify, and deploy the source code to meet your needs. You can also freely deploy **Nebula Graph** as a back-end service to support your SaaS deployment.

In order to prevent cloud providers from monetizing the project without contributing back, we added [Commons Clause 1.0](https://commonsclause.com/) to the project. As mentioned, we are fully committed to the open source community. We would love to hear your thoughts on the licensing model and are willing to make it more suitable for the community.

## Contributing

Contributions are warmly welcomed and greatly appreciated. Here are a few ways you can contribute:

* 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](https://docs.nebula-graph.io/manual-EN/4.contributions/how-to-contribute/).

## Getting help & Contact

In case you encounter any problems playing around **Nebula Graph**, please reach out for help:

* [Official Forum](https://discuss.nebula-graph.io)
* Twitter: [@NebulaGraph](https://twitter.com/NebulaGraph)
* [Facebook page](https://www.facebook.com/NebulaGraph/)
* [LinkedIn page](https://www.linkedin.com/company/vesoft-nebula-graph/)

If you like **Nebula Graph**, please leave us a star.<a href="https://githubbadges.com/star.svg?user=vesoft-inc&repo=nebula&style=default">
<img src="https://githubbadges.com/star.svg?user=vesoft-inc&repo=nebula&style=default" alt="nebula star"/>
</a>