Bunnybook 开源项目安装与使用指南

1. 项目目录结构及介绍

Bunnybook 是一个轻量级的社交网络应用，专为“兔子”设计，由 FastAPI 和 [React+RxJS](https://reactjs.org/, https://rxjs.dev/) 构建而成。下面简要介绍其主要的目录结构：

• backend: 包含后端服务代码，使用Python 3.8编写，基于FastAPI构建。此部分负责处理HTTP请求、数据库交互等。
• frontend: 前端应用程序，采用React.js进行开发，搭配RxJS来处理复杂的事件流逻辑，提供了用户界面。
• docker-compose.yml 和 docker-compose-dev.yml: 容器部署配置文件，分别用于生产环境和开发环境下的Docker容器编排。
• requirements.txt: 后端所需的Python库列表。
• LICENSE: 许可证文件，项目遵循MIT许可协议。
• README.md: 项目简介，包含了快速启动、技术栈、设计理念等信息。

项目中的其他关键文件如.gitignore、docker-compose.*.yml、init_db.py等也都是为了确保项目能够顺利运行和管理而设置。

2. 项目的启动文件介绍

后端启动

• 主入口: backend/main.py是后端服务的主要启动文件，它初始化FastAPI应用并配置路由。
• 运行指令: 使用Docker时，无需直接运行这个文件。若在非容器环境中开发，通过激活虚拟环境后执行python backend/main.py即可启动后端服务。

前端启动

• 前端入口: 前端的启动位于frontend目录内。通过命令行进入该目录执行npm start来启动React开发服务器。

3. 项目的配置文件介绍

• 环境配置:

  • 在实际部署中，环境变量或特定的.env文件常用来存放敏感信息和配置选项。虽然直接的配置文件没有提及，但依赖于环境变量来管理数据库连接字符串、JWT密钥等。

• Docker配置:

  • docker-compose.yml 和 docker-compose-dev.yml 文件承担了配置角色，定义了不同服务（如PostgreSQL、Redis、后端应用、可能还包括Neo4j）如何在Docker容器中运行，包括它们的网络配置、端口映射和服务依赖关系。
  • 开发时推荐使用docker-compose-dev.yml以适应开发环境的需要，比如不同的端口配置和调试需求。

总结来说，Bunnybook项目通过精心组织的目录结构和配置，便于开发者理解与协作。通过Docker容器化，它简化了跨平台的部署与开发流程，使得无论是启动后端服务、前端应用，还是进行全链路测试，都能做到既快速又一致。