diff --git a/README.md b/README.md index 61930248a5..7b697589a1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ hugegraph-logo -

A graph database that supports more than 10 billion data, high performance and scalability

+

A graph database that supports more than 10 billion data, high performance and +scalability

@@ -15,84 +16,123 @@ ## What is Apache HugeGraph? -[HugeGraph](https://hugegraph.apache.org/) is a fast-speed and highly-scalable [graph database](https://en.wikipedia.org/wiki/Graph_database). -Billions of vertices and edges can be easily stored into and queried from HugeGraph due to its excellent OLTP ability. -As compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/) framework, various complicated graph queries can be -achieved through [Gremlin](https://tinkerpop.apache.org/gremlin.html)(a powerful graph traversal language). - +[HugeGraph](https://hugegraph.apache.org/) is a fast-speed and +highly-scalable [graph database](https://en.wikipedia.org/wiki/Graph_database). +Billions of vertices and edges can be easily stored into and queried from HugeGraph due to its +excellent OLTP ability. +As compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/) framework, various complicated +graph queries can be +achieved through [Gremlin](https://tinkerpop.apache.org/gremlin.html)(a powerful graph traversal +language). ## Features -- Compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/), support [Gremlin](https://tinkerpop.apache.org/gremlin.html) & [Cypher](https://en.wikipedia.org/wiki/Cypher) language +- Compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/), + support [Gremlin](https://tinkerpop.apache.org/gremlin.html) & [Cypher](https://en.wikipedia.org/wiki/Cypher) + language - Schema Metadata Management, including VertexLabel, EdgeLabel, PropertyKey and IndexLabel - Multi-type Indexes, supporting exact query, range query and complex conditions combination query -- Plug-in Backend Store Driver Framework, support `RocksDB`, `Cassandra`, `HBase`, `ScyllaDB`, and `MySQL/Postgre` now and easy to add another backend store driver if needed +- Plug-in Backend Store Driver Framework, support `RocksDB`, `Cassandra`, `HBase`, `ScyllaDB`, + and `MySQL/Postgre` now and easy to add another backend store driver if needed - Integration with `Flink/Spark/HDFS`, and friendly to connect other big data platforms - ## Quick Start ### 1. Docker Way (Convenient for Test) -We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` to quickly start an inner +We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` to quickly start an inner HugeGraph server with `RocksDB` (in backgrounds) for **test/dev**. You can visit [doc page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#3-deploy) or -the [README](hugegraph-server/hugegraph-dist/docker/READEME.md) for more details. ([Docker Compose](./hugegraph-server/hugegraph-dist/docker/example)) +the [README](hugegraph-server/hugegraph-dist/docker/READEME.md) for more +details. ([Docker Compose](./hugegraph-server/hugegraph-dist/docker/example)) > Note: -> -> 1. The docker image of hugegraph is a convenience release, but not **official distribution** artifacts. You can find more details from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub). -> -> 2. Recommend to use `release tag`(like `1.2.0`) for the stable version. Use `latest` tag to experience the newest functions in development. +> +> 1. The docker image of hugegraph is a convenience release, but not **official distribution** + artifacts. You can find more details + from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub). +> +> 2. Recommend to use `release tag`(like `1.2.0`) for the stable version. Use `latest` tag to + experience the newest functions in development. ### 2. Download Way -Visit [Download Page](https://hugegraph.apache.org/docs/download/download/) and refer the [doc](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#32-download-the-binary-tar-tarball) +Visit [Download Page](https://hugegraph.apache.org/docs/download/download/) and refer +the [doc](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#32-download-the-binary-tar-tarball) to download the latest release package and start the server. ### 3. Source Building Way -Visit [Source Building Page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#33-source-code-compilation) and follow the +Visit [Source Building Page](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#33-source-code-compilation) +and follow the steps to build the source code and start the server. The project [doc page](https://hugegraph.apache.org/docs/) contains more information on HugeGraph and provides detailed documentation for users. (Structure / Usage / API / Configs...) And here are links of other **HugeGraph** component/repositories: -1. [hugegraph-toolchain](https://github.com/apache/hugegraph-toolchain) (graph tools **[loader](https://github.com/apache/incubator-hugegraph-toolchain/tree/master/hugegraph-loader)/[dashboard](https://github.com/apache/incubator-hugegraph-toolchain/tree/master/hugegraph-hubble)/[tool](https://github.com/apache/incubator-hugegraph-toolchain/tree/master/hugegraph-tools)/[client](https://github.com/apache/incubator-hugegraph-toolchain/tree/master/hugegraph-client)**) -2. [hugegraph-computer](https://github.com/apache/hugegraph-computer) (integrated **graph computing** system) + +1. [hugegraph-toolchain](https://github.com/apache/hugegraph-toolchain) (graph tools * + *[loader](https://github.com/apache/incubator-hugegraph-toolchain/tree/master/hugegraph-loader)/[dashboard](https://github.com/apache/incubator-hugegraph-toolchain/tree/master/hugegraph-hubble)/[tool](https://github.com/apache/incubator-hugegraph-toolchain/tree/master/hugegraph-tools)/[client](https://github.com/apache/incubator-hugegraph-toolchain/tree/master/hugegraph-client) + **) +2. [hugegraph-computer](https://github.com/apache/hugegraph-computer) (integrated **graph computing + ** system) 3. [hugegraph-commons](https://github.com/apache/hugegraph-commons) (**common & rpc** libs) 4. [hugegraph-website](https://github.com/apache/hugegraph-doc) (**doc & website** code) -5. [hugegraph-ai](https://github.com/apache/incubator-hugegraph-ai) (integrated **Graph AI/LLM/KG** system) +5. [hugegraph-ai](https://github.com/apache/incubator-hugegraph-ai) (integrated **Graph AI/LLM/KG** + system) ## License HugeGraph is licensed under [Apache 2.0 License](LICENSE). +## Making Your First Contribution -## Contributing +We welcome all contributions to HugeGraph, please +see [`How to Contribute`](CONTRIBUTING.md) & [Guidelines](https://hugegraph.apache.org/docs/contribution-guidelines/) +for more information. Here are some ways you can help: -- Welcome to contribute to HugeGraph, please see [`How to Contribute`](CONTRIBUTING.md) & [Guidelines](https://hugegraph.apache.org/docs/contribution-guidelines/) for more information. -- Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to greatly simplify the PR and commit process. -- Thank you to all the people who already contributed to HugeGraph! +- Tutorials + Blogposts: We always want to find ways to improve the user experience and sharing uses + for HugeGraph is a huge help. +- Documentation Improvements: If something isn't clear or you discover some new tips that could be + helpful, feel free to share! +- Bug Reports: We always welcome issues with HugeGraph so please submit any bugs that you discover. +- Feature Requests: If HugeGraph is missing a feature, submit a feature request! -[![contributors graph](https://contrib.rocks/image?repo=apache/hugegraph)](https://github.com/apache/incubator-hugegraph/graphs/contributors) +Pull Requests + +- Even small changes such as a typo fix are welcome if it helps the project. +- Make sure you check existing issues before opening a new issue. +- Follow established coding styles and + reference [style guide](https://github.com/apache/incubator-hugegraph/wiki/The-style-config-for-HugeGraph-in-IDEA) + whenever you are in doubt. +- Reach out on Github to ask questions! +Note: It's recommended to use [GitHub Desktop](https://desktop.github.com/) to greatly simplify the +PR and commit process. + +Thank you to all the people who already contributed to HugeGraph! + +[![contributors graph](https://contrib.rocks/image?repo=apache/hugegraph)](https://github.com/apache/incubator-hugegraph/graphs/contributors) ## Thanks -HugeGraph relies on the [TinkerPop](http://tinkerpop.apache.org) framework, we refer to the storage structure of Titan and the schema definition of DataStax. -Thanks to TinkerPop, thanks to Titan, thanks to DataStax. Thanks to all other organizations or authors who contributed to the project. +HugeGraph relies on the [TinkerPop](http://tinkerpop.apache.org) framework, we refer to the storage +structure of Titan and the schema definition of DataStax. +Thanks to TinkerPop, thanks to Titan, thanks to DataStax. Thanks to all other organizations or +authors who contributed to the project. -You are welcome to contribute to HugeGraph, +You are welcome to contribute to HugeGraph, and we are looking forward to working with you to build an excellent open-source community. - ## Contact Us -- [GitHub Issues](https://github.com/apache/incubator-hugegraph/issues): Feedback on usage issues and functional requirements (quick response) - - Feedback Email: [dev@hugegraph.apache.org](mailto:dev@hugegraph.apache.org) ([subscriber](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/) only) - - WeChat public account: Apache HugeGraph, welcome to scan this QR code to follow us. +- [GitHub Issues](https://github.com/apache/incubator-hugegraph/issues): Feedback on usage issues + and functional requirements (quick response) +- Feedback + Email: [dev@hugegraph.apache.org](mailto:dev@hugegraph.apache.org) ([subscriber](https://hugegraph.apache.org/docs/contribution-guidelines/subscribe/) + only) +- WeChat public account: Apache HugeGraph, welcome to scan this QR code to follow us. QR png