kir-dev/ehk
GitHub: kir-dev/ehk
EHK 组织门户网站的现代化重构项目,采用 Payload CMS 和 PostgreSQL 构建内容管理系统。
Stars: 2 | Forks: 0
## 项目设置指南
本指南将帮助您在本地设置该项目。
### 前置条件
请确保您的计算机上已安装以下软件:
- Node.js (v16 或更高版本)
- Yarn (v1.22.22 或更高版本)
- Docker
### 安装步骤
1. **克隆仓库:**
git clone <仓库-url>
2. **安装依赖项:**
yarn install
3. **设置环境变量:**
- 将 `.env.example` 文件复制为 `.env`:
- 如有必要,使用您的特定值更新 `.env` 文件。
4. **使用 Docker 启动 PostgreSQL 数据库:**
docker-compose up -d
5. **运行开发服务器:**
yarn dev
### 其他命令
- **构建项目:**
yarn build
- **启动生产服务器:**
yarn start
- **检查项目代码规范:**
yarn lint
### 迁移 (Payload + Postgres)
本项目使用连接到 Postgres 适配器的 Payload migrate CLI。迁移文件位于 `./src/migrations`,并由 `./src/migrations/index.ts` 索引。
常见任务:
- 创建一个新的迁移(自动生成带时间戳的文件):
yarn migrate:create <名称>
# 示例
yarn migrate:create add_regulations_file_eng
选项:
- `--skip-empty` 用于在没有更改时避免创建空的迁移
- 应用待处理的迁移:
yarn migrate
- 显示迁移状态:
yarn migrate:status
- 回滚上一批迁移:
yarn migrate:down
- 重置/刷新(请谨慎使用):
yarn migrate:reset # 运行所有 down 操作
yarn migrate:refresh # 运行 down 操作然后运行 up 操作
yarn migrate:fresh # 删除数据库并运行 up 操作(脚本中已需要 --yes)
典型工作流程:
1. 修改您的 Payload collections/config。
2. 生成迁移:`yarn migrate:create meaningful_name`。
3. 检查 `src/migrations/` 中生成的文件(它通过 `db.execute(sql\`...\`)` 使用 Postgres SQL)。
4. 运行 `yarn migrate` 以应用。
注意:
- CLI 会自动更新 `src/migrations/index.ts`。除非您知道自己在做什么,否则请避免手动编辑。
- 确保设置了数据库环境变量(例如 `DATABASE_URL`)。对于 `migrate:create`,Payload 在不连接数据库的情况下初始化;对于运行迁移,必须能够连接到数据库。
- 脚本位于 `package.json` 的 `scripts` 下。
### 注意事项
- 在启动开发服务器之前,请确保 Docker 正在运行。
- 数据库连接字符串和其他密钥在 `.env` 文件中管理。
- 项目使用 Tailwind CSS 进行样式设计,使用 Payload CMS 进行内容管理。
标签:CISA项目, DNS 反向解析, DNS解析, Docker, EHK, GNU通用公共许可证, IP 地址批量处理, MITM代理, NIDS, Node.js, Payload CMS, PostgreSQL, SQL, Syscall, Web开发, Yarn, 内容管理系统, 匈牙利, 安全防御评估, 容器化, 开发指南, 开源项目, 数据库迁移, 无头CMS, 测试用例, 环境配置, 系统审计, 网站重构, 自动化攻击, 请求拦截