Neo4jr-Social 项目技术文档

1. 安装指南

1.1 环境准备

在安装 Neo4jr-Social 之前，请确保您的系统满足以下前提条件：

• Java：Neo4jr-Social 依赖于 Java 环境。
• JRuby：项目使用 JRuby 编写，因此需要安装 JRuby。
• 依赖包：使用以下命令安装所需的依赖包：

  sudo aptitude install jruby1.2 rake rubygems
  

1.2 安装 RVM

为了管理 Ruby 版本，建议安装 RVM（Ruby Version Manager）。您可以通过以下命令安装 RVM：

curl -sSL https://get.rvm.io | bash -s stable

1.3 安装 JRuby 及依赖 Gem

安装 RVM 后，使用以下命令安装 JRuby 并设置为默认版本：

rvm install jruby
rvm use --default jruby

接下来，安装项目所需的 Gem：

gem install jruby-openssl
gem install rake
gem install rspec
gem install test-client
gem install rack-test
gem install json-jruby -v 1.4.1
gem install jeweler
gem install warbler
gem install rcov

1.4 构建项目

使用以下命令构建项目代码和文档：

rake gemspec
rake rcov --debug
rake rdoc
rake warify
rake build

或者，您可以使用简化的命令：

rake gemspec warify build

1.5 安装 Neo4jr-Social

构建完成后，使用以下命令安装 Neo4jr-Social：

gem install neo4jr-social

2. 项目使用说明

2.1 启动服务

安装完成后，您可以通过以下命令启动 Neo4jr-Social 服务：

start-neo4jr-social -p8988

默认情况下，服务将在本地监听端口 8988。

2.2 指定数据库目录

您可以通过指定数据库目录来启动服务，如果不指定，数据库将默认创建在临时目录中，并在服务关闭时被删除：

start-neo4jr-social -p8988 -dsome_relative_or_absolute_directory

2.3 查看帮助

使用以下命令查看所有可用选项：

start-neo4jr-social --help

3. 项目 API 使用文档

3.1 动态节点创建

Neo4jr-Social 支持通过 HTTP REST + JSON 接口动态创建节点。您可以通过发送 POST 请求到 /nodes 端点来创建新节点。

3.2 构建节点关系

通过发送 POST 请求到 /relationships 端点，您可以在两个节点之间建立关系。

3.3 社交网络查询

项目内置了一些常见的社交网络查询，例如：

• LinkedIn 的度数分离：查询两个节点之间的最短路径。
• Facebook 好友推荐：基于共同好友推荐潜在好友。

4. 项目安装方式

4.1 通过 Ruby Gem 安装

最简单的安装方式是通过 Ruby Gem 安装：

gem install neo4jr-social

4.2 手动构建与安装

如果您需要手动构建项目，请按照以下步骤操作：

1. 安装 RVM 并设置 JRuby 为默认版本。
2. 安装所需的 Gem。
3. 使用 rake 命令构建项目。
4. 使用 gem install 命令安装 Neo4jr-Social。

通过以上步骤，您可以顺利安装并使用 Neo4jr-Social 项目。