Geekmarks 开源项目教程

Geekmarks 开源项目教程

geekmarks API-Driven, Geeky Bookmarking Service 项目地址: https://gitcode.com/gh_mirrors/ge/geekmarks

1. 项目的目录结构及介绍

Geekmarks 是一个 API 驱动的极客书签服务，其目录结构如下：

geekmarks/
├── client/
│   ├── ...
│   └── ...
├── server/
│   ├── envs/
│   │   ├── dev/
│   │   └── test/
│   ├── ...
│   └── ...
├── LICENSE
├── Makefile
├── README.md
├── go.mod
├── go.sum
└── ...

目录结构介绍

• client/: 客户端代码目录，包含前端相关的文件。
• server/: 服务器端代码目录，包含后端相关的文件。
  • envs/: 环境配置目录，包含开发和测试环境的配置文件。
    • dev/: 开发环境配置文件。
    • test/: 测试环境配置文件。
• LICENSE: 项目许可证文件，采用 BSD-2-Clause 许可证。
• Makefile: 项目的构建文件，包含编译和运行项目的命令。
• README.md: 项目的说明文件，包含项目的基本介绍和使用说明。
• go.mod: Go 模块文件，定义项目的依赖关系。
• go.sum: Go 模块的校验文件，确保依赖的完整性和安全性。

2. 项目的启动文件介绍

Geekmarks 项目的启动文件主要位于 server/ 目录下。以下是主要的启动文件及其功能介绍：

• server/main.go: 这是服务器的主入口文件，负责初始化服务器并启动服务。
• server/envs/dev/Makefile: 开发环境的构建文件，包含启动开发服务器的命令。
• server/envs/test/Makefile: 测试环境的构建文件，包含启动测试服务器的命令。

启动步骤

1. 安装依赖: 确保已安装 Go 1.6 或更高版本，并安装 Docker。
2. 配置 OAuth: 在 Google Cloud Console 中创建 OAuth 凭证，并配置授权重定向 URI。
3. 设置环境变量: 创建 /var/tmp/geekmarks_dev/main/google_oauth_creds.yaml 文件，并填入 OAuth 凭证。
4. 安装依赖包: 运行以下命令安装所需的依赖包：

   go get github.com/jteeuwen/go-bindata/
   go get github.com/elazarl/go-bindata-assetfs/
   

5. 启动服务器: 进入项目根目录，运行以下命令启动开发服务器：

   make -C server/envs/dev
   

3. 项目的配置文件介绍

Geekmarks 项目的配置文件主要位于 server/envs/ 目录下，包含开发和测试环境的配置。

配置文件介绍

• server/envs/dev/Makefile: 开发环境的构建文件，包含启动开发服务器的命令。
• server/envs/test/Makefile: 测试环境的构建文件，包含启动测试服务器的命令。
• /var/tmp/geekmarks_dev/main/google_oauth_creds.yaml: OAuth 凭证配置文件，包含 Google OAuth 的客户端 ID 和客户端密钥。

配置文件示例

client_id: "your-google-client-id"
client_secret: "your-google-client-secret"

配置步骤

1. 创建 OAuth 凭证文件: 在 /var/tmp/geekmarks_dev/main/ 目录下创建 google_oauth_creds.yaml 文件，并填入 Google OAuth 的客户端 ID 和客户端密钥。
2. 配置开发环境: 在 server/envs/dev/Makefile 中配置开发环境的启动命令。
3. 配置测试环境: 在 server/envs/test/Makefile 中配置测试环境的启动命令。

通过以上步骤，您可以成功配置并启动 Geekmarks 项目。

geekmarks API-Driven, Geeky Bookmarking Service 项目地址: https://gitcode.com/gh_mirrors/ge/geekmarks