100 lines
3.5 KiB
Markdown
100 lines
3.5 KiB
Markdown
## 介绍
|
||
|
||
项目介绍
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
├── README.md # 说明文档
|
||
├── components.json # 组件库配置
|
||
├── eslint.config.js # eslint 配置
|
||
├── index.html # 入口文件
|
||
├── package.json # 包管理
|
||
├── postcss.config.js # postcss 配置
|
||
├── public # 静态资源目录
|
||
│ ├── favicon.png # 图标
|
||
│ └── images # 图片资源
|
||
├── src # 源码目录
|
||
│ ├── App.tsx # 入口文件
|
||
│ ├── components # 组件目录
|
||
│ ├── context # 上下文目录
|
||
│ ├── db # 数据库配置目录
|
||
│ ├── hooks # 通用钩子函数目录
|
||
│ ├── index.css # 全局样式
|
||
│ ├── layout # 布局目录
|
||
│ ├── lib # 工具库目录
|
||
│ ├── main.tsx # 入口文件
|
||
│ ├── routes.tsx # 路由配置
|
||
│ ├── pages # 页面目录
|
||
│ ├── services # 数据库交互目录
|
||
│ ├── types # 类型定义目录
|
||
├── tsconfig.app.json # ts 前端配置文件
|
||
├── tsconfig.json # ts 配置文件
|
||
├── tsconfig.node.json # ts node端配置文件
|
||
└── vite.config.ts # vite 配置文件
|
||
```
|
||
|
||
## 技术栈
|
||
|
||
Vite、TypeScript、React、Supabase
|
||
|
||
## 本地开发
|
||
|
||
### 如何在本地编辑代码？
|
||
|
||
您可以选择 [VSCode](https://code.visualstudio.com/Download) 或者您常用的任何 IDE 编辑器，唯一的要求是安装 Node.js 和 npm.
|
||
|
||
### 环境要求
|
||
|
||
```
|
||
# Node.js ≥ 20
|
||
# npm ≥ 10
|
||
例如：
|
||
# node -v # v20.18.3
|
||
# npm -v # 10.8.2
|
||
```
|
||
|
||
具体安装步骤如下：
|
||
|
||
### 在 Windows 上安装 Node.js
|
||
|
||
```
|
||
# Step 1: 访问Node.js官网：https://nodejs.org/，点击下载后，会根据你的系统自动选择合适的版本（32位或64位）。
|
||
# Step 2: 运行安装程序：下载完成后，双击运行安装程序。
|
||
# Step 3: 完成安装：按照安装向导完成安装过程。
|
||
# Step 4: 验证安装：在命令提示符（cmd）或IDE终端（terminal）中输入 node -v 和 npm -v 来检查 Node.js 和 npm 是否正确安装。
|
||
```
|
||
|
||
### 在 macOS 上安装 Node.js
|
||
|
||
```
|
||
# Step 1: 使用Homebrew安装（推荐方法）：打开终端。输入命令brew install node并回车。如果尚未安装Homebrew，需要先安装Homebrew，
|
||
可以通过在终端中运行如下命令来安装：
|
||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
||
或者使用官网安装程序：访问Node.js官网。下载macOS的.pkg安装包。打开下载的.pkg文件，按照提示完成安装。
|
||
# Step 2: 验证安装：在命令提示符（cmd）或IDE终端（terminal）中输入 node -v 和 npm -v 来检查 Node.js 和 npm 是否正确安装。
|
||
```
|
||
|
||
### 安装完后按照如下步骤操作：
|
||
|
||
```
|
||
# Step 1: 下载代码包
|
||
# Step 2: 解压代码包
|
||
# Step 3: 用IDE打开代码包，进入代码目录
|
||
# Step 4: IDE终端输入命令行，安装依赖：npm i
|
||
# Step 5: IDE终端输入命令行，启动开发服务器：npm run dev -- --host 127.0.0.1
|
||
```
|
||
|
||
### 如何开发后端服务？
|
||
|
||
配置环境变量，安装相关依赖
|
||
如需使用数据库，请使用 supabase 官方版本或自行部署开源版本的 Supabase
|
||
|
||
### 如何配置应用中的三方 API？
|
||
|
||
具体三方 API 调用方法，请参考帮助文档：[源码导出](https://cloud.baidu.com/doc/MIAODA/s/Xmewgmsq7)，了解更多详细内容。
|
||
|
||
## 了解更多
|
||
|
||
您也可以查看帮助文档：[源码导出](https://cloud.baidu.com/doc/MIAODA/s/Xmewgmsq7)，了解更多详细内容。
|