exitus 项目使用教程

exitus 项目使用教程

exitus exitus is a very simple issue tracking API 项目地址: https://gitcode.com/gh_mirrors/ex/exitus

1、项目介绍

exitus 是一个非常简单的任务跟踪 API，它是一个用 Go 语言编写的后端微服务，主要用于从 PostgreSQL 数据库中提供数据服务。项目名称 "exitus" 源自拉丁语 "exire"，意为“出去”，与“issue”（问题）的词源相关。该项目的目标是展示如何构建一个可观察、操作友好、安全且具有良好测试覆盖率的后端服务。

2、项目快速启动

环境准备

在开始之前，请确保你已经安装了以下工具和环境：

• Go 语言环境
• Docker 和 Docker Compose
• PostgreSQL 数据库

克隆项目

首先，克隆 exitus 项目到本地：

git clone https://github.com/wolfeidau/exitus.git
cd exitus

配置环境变量

在项目根目录下，创建一个 .env 文件，并添加以下环境变量：

# AWS 配置
export AWS_PROFILE=whatever
export AWS_REGION=ap-southeast-2

# PostgreSQL 密码
export POSTGRES_PASSWORD=xxx
export POSTGRES_ROOT_PASSWORD=xxx

# OAuth 配置
export OAUTH_CLIENT_ID=xxx
export OAUTH_CLIENT_SECRET=xxx
export OPENID_PROVIDER_URL=https://cognito-idp.ap-southeast-2.amazonaws.com/ap-southeast-2_XXXXXXXXXS

# CDK 部署配置
export STAGE=dev
export BRANCH=master
export DOMAIN_NAME=whatever.cloud
export HOSTED_ZONE_ID=XXXXXXXXXXXXX
export ACM_CERTIFICATE_ARN=arn:aws:acm:ap-southeast-2:123456789012:certificate/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

启动服务

使用 Docker Compose 启动服务：

make docker-compose-test

运行测试

在启动服务后，可以运行测试以确保一切正常：

make test

3、应用案例和最佳实践

应用案例

exitus 可以用于构建一个简单的任务管理系统，例如：

• 任务跟踪系统：用户可以创建、更新和删除任务，系统会自动记录任务的状态变化。
• 项目管理工具：结合其他项目管理工具，exitus 可以作为一个后端服务，提供任务数据的存储和查询。

最佳实践

• 安全性：使用 OAuth 和 JWT 进行身份验证和授权，确保数据的安全性。
• 可观察性：通过提供指标、结构化日志和开放追踪数据，确保服务的可观察性。
• 操作友好性：通过环境变量进行配置，简化部署模型，使用 Docker 或二进制文件进行部署。

4、典型生态项目

exitus 作为一个后端微服务，可以与其他项目结合使用，构建更复杂的系统。以下是一些典型的生态项目：

• PostgreSQL：作为数据存储的核心数据库。
• Prometheus：用于收集和监控服务的指标数据。
• Grafana：用于可视化 Prometheus 收集的指标数据。
• Jaeger：用于分布式追踪，帮助分析服务的性能瓶颈。

通过结合这些生态项目，exitus 可以构建一个完整、可观察、操作友好的任务管理系统。

exitus exitus is a very simple issue tracking API 项目地址: https://gitcode.com/gh_mirrors/ex/exitus