chore: 初始化仓库基础文件

- 新增 Git 与 Docker 忽略规则

- 新增项目首页 README 并接入管理端 logo
This commit is contained in:
2026-03-20 12:42:49 +08:00
commit 1a2a078c0f
3 changed files with 107 additions and 0 deletions

11
.dockerignore Normal file
View File

@@ -0,0 +1,11 @@
.git
.idea
.DS_Store
**/node_modules
**/dist
**/coverage
**/target
deploy/data
frontend_miniprogram

25
.gitignore vendored Normal file
View File

@@ -0,0 +1,25 @@
.DS_Store
.idea/
node_modules/
dist/
coverage/
.env.local
.env.*.local
target/
**/target/
frontend_admin/node_modules/
frontend_admin/dist/
frontend_admin/dist.zip
frontend_admin/vite.config.js
frontend_admin/vite.config.d.ts
frontend_miniprogram/node_modules/
frontend_miniprogram/project.private.config.json
*.log
deploy/data/*
!deploy/data/.gitkeep
deploy/release/*.zip
docker/

71
README.md Normal file
View File

@@ -0,0 +1,71 @@
<p align="center">
<img src="./frontend_admin/public/favicon.svg" alt="EasyCard Logo" width="96" />
</p>
<h1 align="center">EasyCard</h1>
<p align="center">多租户电子名片系统</p>
## 简介
EasyCard 是一套面向事务所/组织的电子名片系统,包含后台管理端、后端服务与微信小程序三部分。
- 后端统一提供租户、组织、用户、名片、文件、统计等能力
- 管理端用于平台管理、租户管理与日常运营
- 小程序面向访客展示机构与个人电子名片
## 项目结构
```text
easycard/
├─ backend/ # Spring Boot 后端
├─ frontend_admin/ # Vue 3 管理端
├─ frontend_miniprogram/ # 微信小程序
├─ deploy/ # 部署与环境配置
└─ docs/ # 技术、数据库与环境文档
```
## 技术栈
- 后端Java 21、Spring Boot 3、MyBatis-Plus、MySQL、Redis、MinIO、Flyway
- 管理端Vue 3、TypeScript、Vite、Pinia、Element Plus
- 小程序原生微信小程序、TypeScript、Less
## 快速开始
### 1. 启动依赖服务
优先参考部署目录中的容器配置与脚本:
- `deploy/docker-compose.yml`
- `deploy/application.yml`
### 2. 启动后端
```bash
cd backend
mvn -pl easycard-boot spring-boot:run
```
### 3. 启动管理端
```bash
cd frontend_admin
npm install
npm run dev
```
### 4. 启动小程序
使用微信开发者工具打开 `frontend_miniprogram/` 目录进行预览与调试。
## 文档
- 技术方案:[docs/技术文档.md](./docs/技术文档.md)
- 数据库设计:[docs/数据库设计文档.md](./docs/数据库设计文档.md)
- 本地中间件环境:[docs/本地中间件环境说明.md](./docs/本地中间件环境说明.md)
## 说明
- 管理端与小程序共用同一套后端服务
- 当前仓库适合本地开发、联调和私有化部署扩展