Catarse 技术文档

本文档旨在帮助用户安装、使用 Catarse 项目，并详细解释项目 API 的使用方法。

1. 安装指南

环境依赖

在运行本项目之前，您需要确保以下依赖项已正确安装：

• Ruby 2.4.1
• Rails 4.2
• postgREST 0.3
• PostgreSQL 9.4
  • OSX 用户请安装 Postgres.app
  • Linux 用户请执行 $ sudo apt-get install postgresql
  • Windows 用户请下载 PostgreSQL for Windows

重要提示：确保系统中已安装 postgresql-contrib（附加模块）。

安装步骤

1. 克隆项目

   $ git clone https://github.com/catarse/catarse.git
   

2. 进入项目目录

   $ cd catarse
   

3. 创建 database.yml 配置文件

   $ cp config/database.sample.yml config/database.yml
   

   配置您的本地数据库，添加数据库用户名和密码（如果有的话）。

4. 安装宝石

   $ bundle install
   

5. 安装前端依赖

   $ npm install
   

   需要 Node.js 和其包管理器，npm。

6. 创建并初始化数据库

   $ rake db:create db:migrate db:seed
   

7. 配置 API 服务器

   $ bundle exec rails console
   > CatarseSettings[:api_host] = "http://localhost:3004" # postgREST 服务器 URL
   > CatarseSettings[:jwt_secret] = "gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr9C" # 这是一个有效的示例令牌
   

如果一切顺利，您可以开始运行项目了！

2. 项目使用说明

运行项目

1. 运行 API 服务器

   $ ./postgrest postgres://postgrest@localhost/catarse_development -a anonymous --jwt-secret gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr9C -s 1 -p 3004
   

2. 运行 Rails 服务器

   $ rails server
   

   打开浏览器，访问 http://localhost:3000。

3. 项目 API 使用文档

API 服务器使用 JWT（JSON Web Tokens）进行身份验证。您可以通过 CatarseSettings 在 Rails 控制台中配置相关设置。

$ bundle exec rails console
> CatarseSettings[:api_host] = "http://localhost:3004" # postgREST 服务器 URL
> CatarseSettings[:jwt_secret] = "gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr9C" # 有效的示例令牌

4. 项目安装方式

请按照上述“安装指南”中的步骤进行安装。确保所有依赖项已正确安装，并按照步骤操作，即可成功安装并运行 Catarse 项目。

---

本文档提供了 Catarse 项目的安装指南、使用说明以及 API 使用文档。遵循这些指南，您将能够顺利地安装和使用 Catarse 项目。