Nimbus 的安装和配置教程

1. 项目的基础介绍和主要的编程语言

Nimbus 是一个开源的云存储项目，旨在提供一个类似于 Google Drive、OneDrive 或 iCloud 的云服务解决方案。该项目使用现代的编程语言和技术，旨在提供一个安全、可靠且易于使用的云存储服务。

该项目主要使用 TypeScript 进行开发，这是一种由微软开发的开源编程语言，它是 JavaScript 的一个超集，增加了静态类型选项。

2. 项目使用的关键技术和框架

Nimbus 项目使用了以下关键技术和框架：

• TypeScript: 作为主要的编程语言，提供了类型安全性和更好的开发体验。
• Node.js: 服务器端运行环境，允许在服务器上执行 JavaScript 代码。
• Express.js: 一个灵活的 Node.js Web 应用程序框架，用于创建 HTTP 服务器。
• PostgreSQL: 一个功能强大的开源对象关系型数据库系统，用于数据存储。
• Docker: 一个开源的应用容器引擎，用于自动化部署应用程序。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

在开始安装之前，请确保您的系统中已安装以下软件：

• Node.js（推荐使用最新版）
• Docker
• Git

安装步骤

1. 克隆仓库

   使用 Git 克隆项目仓库到本地：

   git clone https://github.com/logscore/Nimbus.git
   cd Nimbus
   

2. 安装依赖

   使用以下命令安装项目依赖：

   bun i
   

3. 设置 PostgreSQL 数据库

   我们使用 Docker 运行 PostgreSQL 数据库进行本地开发。按照以下步骤设置：

   • 启动数据库：

     bun db:up
     

     这将启动一个带有默认凭据的 Postgres 容器：

     • 主机：localhost
     • 端口：5432
     • 数据库：nimbus
     • 用户名：postgres
     • 密码：postgres

   • 验证数据库运行状态（如果是运行在分离的容器中）：

     docker compose ps
     

     你应该能在列表中看到状态为 "Up" 的 nimbus-db 容器。

   • （可选）使用 psql 客户端连接到容器内的数据库：

     docker compose exec postgres psql -U postgres -d nimbus
     

4. 环境设置

   将 .env.example 文件复制为 .env 文件，并填写以下值：

   cp .env.example .env
   

   填写的值可能包括：

   • GOOGLE_CLIENT_ID
   • GOOGLE_CLIENT_SECRET
   • BETTER_AUTH_SECRET（使用 openssl rand -base64 32 生成）
   • BETTER_AUTH_URL

5. 运行数据库迁移

   在设置好数据库后，运行迁移：

   bun db:migrate
   

6. 启动开发服务器

   在新的终端窗口中，启动开发服务器：

   bun dev
   

   注意：这会同时启动 Web 和服务器开发服务器。如果你只想运行其中一个，可以使用 bun dev:web 或 bun dev:server。两者都需要数据库运行才能正常工作。

   应用程序现在应该可以在 http://localhost:3000 上运行。

以上就是 Nimubs 的安装和配置教程，按照上述步骤操作，你就可以成功搭建并运行这个开源云存储项目了。