首页
/ Catarse 技术文档

Catarse 技术文档

2024-12-17 18:43:09作者:殷蕙予

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

1. 安装指南

环境依赖

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

重要提示:确保系统中已安装 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 项目。

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
574
416
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
125
208
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
77
146
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
442
39
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
253
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
693
91
folibfolib
FOLib 是一个为Ai研发而生的、全语言制品库和供应链服务平台
Java
108
6
CS-BooksCS-Books
🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~
120
16
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
299
1.03 K