Files
Astral3D/astral-service/README.md
lyf cda4999325 完善项目文档和SDK功能
- 更新 README 文档和许可证文件
- 完善编辑器使用手册,包括BIM浏览、CAD查看等功能说明
- 更新文档配置和首页内容
- 优化编辑器环境配置
- 完善 WebSocket 通信和 API 接口
- 增强 glTF 处理器和点云重建功能
- 优化 SDK 核心模块:
  - 更新 App 和 Config 配置
  - 添加 Billboard、HtmlPanel 等对象支持
  - 完善粒子系统和天气效果
  - 优化相机管理和漫游工具
  - 改进材质着色器效果
- 更新服务层 README 文档

Made-with: Cursor
2026-03-14 00:26:51 +08:00

78 lines
1.7 KiB
Markdown

# AstralService
🌍 *[简体中文](README.md)* | English
Backend service for NeonVision 3D Editor.
Based on `Java 8` and `SpringBoot 2.7.18`.
![Static Badge](https://img.shields.io/badge/Java-8-green)
![Static Badge](https://img.shields.io/badge/SpringBoot-2.7.18-8732D7)
![Static Badge](https://img.shields.io/badge/license-MIT-blue)
## Prerequisites
- Java 8+
- Maven 3.6+
- MySQL 5.7+
## Quick Start
```shell
git clone http://code-server:3000/lyf/Astral3D.git
cd astral-service
```
### Database Setup
1. Create database and import schema:
```sql
mysql -u root -p < static/sql/astral_3d.sql
```
2. Configure database connection in:
```
astral-web/src/main/resources/application-dev.yml
```
### Configuration
Edit `astral-web/src/main/resources/application-dev.yml`:
| Property | Description |
|----------|-------------|
| `spring.datasource` | Your MySQL connection settings |
| `astral.uploadType` | Storage type: `local` or `upyun` |
| `astral.uploadDir` | Storage directory path |
| `upyun.bucket` | UpYun bucket name (if using UpYun) |
| `upyun.operator` | UpYun operator account |
| `upyun.password` | UpYun operator password |
| `upyun.domain` | UpYun CDN domain |
| `dev.currentAbPath` | Project absolute path |
| `dev.cadDwgConverterAbPath` | CAD DWG converter path (libreDWG) |
| `dev.temporaryFolder` | Temporary folder path |
### Running
**Option 1: IDEA**
Run the main class:
```
astral-web/src/main/java/com.astral.web/AstralWebApplication/AstralWebApplication
```
**Option 2: Maven**
```bash
mvn spring-boot:run
```
**Option 3: JAR Package**
```bash
mvn clean package
cd astral-web/target
java -jar astral-web-exec.jar
```
## License
Open source under MIT License.