Owlistic笔记项目开发环境搭建指南

项目概述

Owlistic是一个现代化的笔记应用项目，采用前后端分离架构开发。前端使用Flutter框架构建跨平台应用，后端采用Go语言开发高性能服务。本文将详细介绍如何搭建完整的开发环境，帮助开发者快速上手项目开发。

环境准备

基础工具安装

在开始之前，请确保你的开发机器已安装以下必备工具：

1. Go语言环境：版本1.23或更高，用于后端服务开发
2. Flutter SDK：最新稳定版，用于跨平台应用开发
3. Git版本控制：用于代码管理和协作开发
4. Docker环境：包括Docker和Docker Compose，用于容器化部署
5. 代码编辑器：推荐使用Visual Studio Code，它提供了优秀的Go和Flutter开发支持

环境验证

安装完成后，请执行以下命令验证各组件是否安装正确：

# 验证Go安装
go version

# 验证Flutter安装
flutter doctor

# 验证Docker安装
docker --version
docker-compose --version

项目初始化

获取项目代码

首先需要将项目代码克隆到本地开发环境：

git clone <项目仓库地址>
cd owlistic

项目结构说明

Owlistic项目采用标准化的目录结构：

owlistic/
├── src/
│   ├── backend/    # Go后端服务代码
│   └── frontend/   # Flutter前端应用代码
├── docker-compose.yml # 容器编排配置
└── README.md       # 项目说明文档

后端服务配置

依赖管理

进入后端目录并下载依赖：

cd src/backend
go mod download

编译构建

使用Go工具链编译项目：

go build -o build/owlistic cmd/main.go

依赖服务启动

Owlistic后端依赖PostgreSQL数据库和NATS消息系统，推荐使用Docker快速启动：

docker-compose up -d postgres nats

环境变量配置

后端服务需要以下环境变量：

export DB_HOST=localhost      # 数据库主机
export DB_PORT=5432           # 数据库端口
export DB_USER=admin          # 数据库用户名
export DB_PASSWORD=admin      # 数据库密码
export DB_NAME=postgres       # 数据库名称
export BROKER_ADDRESS=localhost:9092 # 消息代理地址

启动服务

编译完成后，可以运行后端服务：

./build/owlistic

服务默认监听8080端口，可通过http://localhost:8080访问。

前端应用配置

进入前端目录

cd src/frontend

安装依赖

Flutter项目使用pub管理依赖：

flutter pub get

启动开发服务器

使用以下命令启动Flutter web应用：

flutter run -d chrome

此命令会自动打开Chrome浏览器并加载开发版本的应用。

开发工作流建议

代码修改与热重载

1. 后端修改：需要重新编译并重启服务
2. 前端修改：Flutter支持热重载，大多数修改会自动反映在浏览器中

测试验证

在提交代码前，建议运行完整的测试套件：

# 后端测试
cd src/backend
go test ./...

# 前端测试
cd src/frontend
flutter test

容器化开发环境

为简化开发环境配置，项目提供了完整的Docker Compose配置：

docker-compose up -d

此命令会启动所有依赖服务以及应用本身，适合快速验证完整功能。

开发建议

1. 代码风格：遵循各语言的官方代码风格指南
2. 提交规范：使用清晰的提交信息，说明修改内容和原因
3. 分支管理：建议为每个功能或修复创建独立的分支
4. 文档更新：修改功能时同步更新相关文档

通过以上步骤，你应该已经成功搭建了Owlistic项目的完整开发环境，可以开始进行功能开发和贡献了。