Hemmelig.app 开源项目安装与使用指南

Hemmelig.app 开源项目安装与使用指南

1. 项目目录结构及介绍

Hemmelig.app 是一个用于安全分享敏感信息的平台，它通过端到端加密确保数据的安全性。以下是该项目的基本目录结构及其简介：

.
├── babelrc             # Babel 配置文件，用于JavaScript代码转换
├── client              # 前端应用程序代码所在目录
├── cli.js               # CLI入口文件，允许命令行创建秘密
├── config              # 含有各种配置项如Vite配置
├── CONTRIBUTING.md     # 贡献指南
├── Dockerfile          # Docker构建文件
├── docker-compose.yml  # Docker Compose配置，便于自托管部署
├── editorconfig        # 编辑器配置，统一代码风格
├── env                 # 环境变量示例文件
├── gitignore           # Git忽略文件列表
├── husky                # 用于Git钩子管理的目录
├── karma-hooks         # 测试相关的钩子文件夹
├── package-lock.json   # NPM依赖的确切版本锁定文件
├── package.json        # 包含项目元数据和脚本命令
├── prettierignore      # Prettier应忽略的文件列表
├── prettierrc          # Prettier配置文件，代码格式化规则
├── public              # 静态资源文件夹，如图片和HTML索引文件
├── README.md           # 项目主要的说明文件
├── server              # 后端服务代码所在目录
├── tests               # 测试文件夹，包含服务器端和客户端的测试代码
└── vite.config.js      # Vite构建配置文件

每个子目录或文件都服务于特定的目的，如前端逻辑、后端逻辑、配置、自动化脚本等。

2. 项目的启动文件介绍

• 主要启动脚本通常位于package.json中的scripts部分。对于开发者来说，关键的脚本可能是npm run dev，它会启动开发环境下的前后端应用。

• CLI启动：若要通过命令行快速创建秘密，可以使用项目内部的CLI工具，通过命令npx hemmelig进行交互或通过管道传递数据（例如：cat mysecretfile | npx hemmelig）来创建秘密。

• 生产环境部署，虽然未直接指定一个“启动”文件，但通过Dockerfile和docker-compose.yml，你可以使用Docker来部署整个应用，而无需直接执行某个单一的启动脚本。

3. 项目的配置文件介绍

配置分布在几个文件中：

• 环境变量: 项目依赖于环境变量进行配置，这些变量并未集中在一个文件内，而是散见于.env（虽然示例没直接列出）以及在运行时通过其他方式定义（如Docker环境变量）。重要的环境变量包括数据库连接设置、JWT密钥、主机名和端口等，具体可参照项目文档和环境变量节（如SECRET_LOCAL_HOSTNAME, SECRET_PORT等）。

• Vite配置 (vite.config.js)：负责前端构建的配置，影响开发模式和生产构建的行为，如服务器代理、编译选项等。

• 可能的数据库配置：项目已从Redis转向SQLite，并利用Prisma作为ORM，数据库配置不直接体现在单个配置文件中，更多是通过环境变量（如SECRET_DATABASE_URL或通过Docker容器间通信）来设定。

请注意，实际操作中，具体的配置细节和文件路径可能会根据项目的更新有所变化，因此建议查看最新版本的仓库文档和环境变量清单以获取最准确的信息。