freehire

环境要求

• 已安装 Docker 与 Docker Compose（README 用 docker compose 命令）
• 已安装 GNU Make（需执行 make up）
• 主机 8080 端口空闲，或通过 HIRE_HOST_PORT 另行指定
• 首次启动需拉取构建镜像，建议预留足够磁盘与网络时间

安装与启动步骤

1. 1准备运行环境

   确认 Docker、Docker Compose 和 make 可用，并检查 8080 端口未被占用，否则后面启动会失败。

   docker --version
   docker compose version
   make --version

   复制

2. 2获取项目代码

   从 GitHub 克隆仓库并进入目录，后续所有 make 命令都要在仓库根目录执行。

   git clone https://github.com/strelov1/freehire.git
   cd freehire

   复制

3. 3一键启动全栈

   make up 会构建并启动整套服务：api、web、postgres、meilisearch、redis、s3。

   make up

   复制

4. 4检查健康状态

   访问 api 的健康检查接口，返回正常即说明后端已就绪。

   curl localhost:8080/health

   复制

5. 5验证职位接口

   调用职位列表接口，能返回职位数据说明数据库、检索和服务串联成功。

   curl localhost:8080/api/v1/jobs

   复制

关键配置

如何确认成功

curl localhost:8080/health 返回正常，且 curl localhost:8080/api/v1/jobs 能拿到职位数据即启动成功。

常见问题

注意事项

• docker compose down -v 会删除数据卷，原有职位数据会丢失，谨慎使用。
• README 未提供 LLM、Meilisearch 密钥等配置项的填写方式，相关细节需查阅 docs/ 目录文档。
• 所有 make 命令需在项目根目录执行，避免找不到 Makefile。