# dreamIsland

**Repository Path**: f5l5y5/dreamIsland

## Basic Information

- **Project Name**: dreamIsland
- **Description**: 梦想岛项目
- **Primary Language**: NodeJS
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-24
- **Last Updated**: 2025-09-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <img alt="DreamIsland" width="120" height="120" src="./apps/client/src/static/logo.png">
  <h1>DreamIsland</h1>
   <span><a href="./apps/client/README.md">前端开发文档</a> | <a href="./apps/serve/README.md">后端开发文档</a></span>
</div>

## ⚡ 介绍

一款让你行动无法自拔的产品，快来试一试！

## 🚀 如何开始？

**以下所有相关操作都基于项目根目录位置，请注意检查不要出错！**

### 0. 注意事项

- **pnpm version >= 8**

  ```bash
  corepack enable
  ```

- **Node.js version >= v20**
  > 使用来自 .node-version 的版本 [支持的工具](https://github.com/shadowspawn/node-version-usage#compatibility-testing)
- **MySQL version >= 8.0.0**
- **Redis version >= 5.0.0**
- 项目依赖 **Docker**，所以请确保你本地已安装并成功运行

```bash
docker --version # Docker version 24.0.7, build afdd53b

node --version # v20+

pnpm -v # 8+
```

### 1. 安装依赖

```bash
pnpm install
```

### 2. 启动 Docker Compose 服务

后端用到了 MySQL 和 Redis 服务，通过下面在 `package.json` 中配置的命令启动和停止

```bash
# 启动
pnpm docker:start:dev

# 下面这些命令等你用的时候在执行，不要傻乎乎的刚启动就停止哈 😊
# 停止
pnpm docker:stop:dev
# 完全删除（包括 Volume 数据）
pnpm docker:del
```

当然如果你更喜欢手动挡

```bash
docker compose -f docker-compose.dev.yml up -d
docker compose stop
docker compose down

# 兼容老版本 docker 的命令
docker-compose -f docker-compose.dev.yml up -d
```

### 3. 初始化数据库表结构

执行这个命令时，尽量与上个命令间隔一点时间，因为刚刚使用的 `-d` 参数会让其服务挂起在后台执行，此时 docker 服务可能还在 running 中，若是发现报错了那就再执行一遍 😊

```bash
pnpm db:dev
```

### 4. 初始化数据

**只有第一次初始化数据库后需要执行，注意serve下的sql/all.sql中Account数据库需要定义成自己数据**

```bash
pnpm db:upload
```

### 5. 启动后端服务

```bash
pnpm dev:serve
```

### 6. 启动前端服务

```bash
pnpm dev:client
```

## ❓ 常见问题解答

### pnpm install 报错？

某些依赖模块需要编译安装，因此需要相关编译环境。如果没有对应环境则会编译失败， 且不同模块所需编译环境不同，因此具体问题需要具体分析。
以下列出已经碰到过的具体问题。

先尝试使用下面的命令更新 `pnpm`

```shell
pnpm i -g
# or
pnpm i -g pnpm
# or
npx pnpm i -g pnpm@latest
```