完善项目文档和SDK功能
- 更新 README 文档和许可证文件 - 完善编辑器使用手册,包括BIM浏览、CAD查看等功能说明 - 更新文档配置和首页内容 - 优化编辑器环境配置 - 完善 WebSocket 通信和 API 接口 - 增强 glTF 处理器和点云重建功能 - 优化 SDK 核心模块: - 更新 App 和 Config 配置 - 添加 Billboard、HtmlPanel 等对象支持 - 完善粒子系统和天气效果 - 优化相机管理和漫游工具 - 改进材质着色器效果 - 更新服务层 README 文档 Made-with: Cursor
This commit is contained in:
@@ -1,50 +1,77 @@
|
||||
# AstralService
|
||||
|
||||
🌍
|
||||
*[简体中文](README.md)*
|
||||
|
||||
基于`Java:8`和`SpringBoot:2.7.18`的 [Astral3D](https://github.com/mlt131220/Astral3D) 项目后端代码.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## 快速开始
|
||||
```shell
|
||||
git clone https://github.com/yx8663/astral-service.git
|
||||
```
|
||||
### 配置
|
||||
* 数据库使用 MySQL,表结构数据文件位于: `static/sql/astral_3d.sql`;
|
||||
* 配置文件路径: `astral-web/src/main/resources/application-dev.yml`;
|
||||
* 修改配置文件下 `spring.datasource` 项为自己的数据库连接;
|
||||
* 修改配置文件下 `astral.uploadType` 项为自己使用的文件存储方式:`本地-local 又拍云-upyun`;
|
||||
* 修改配置文件下 `astral.uploadDir` 项为自己使用的文件存储方式对应的存储目录:
|
||||
* `本地-local`存储推荐修改为此项目下的`static`文件夹;
|
||||
* `又拍云-upyun`存储按需配置存储路径;
|
||||
* 如果使用`又拍云-upyun`存储,还需修改配置文件下 `upyun`项配置:
|
||||
* `bucket` 为对应存储桶名;
|
||||
* `operator` 为在又拍云为该桶配置的操作员账号;
|
||||
* `password` 为对应操作员密码;
|
||||
* `domain` 为该存储使用的加速域名(为保证又拍云信息不在前端泄露,故不使用在`HTTP Header`/`HTTP Body`签名认证的方式鉴权,而是配置对应存储的加速域名,将前端请求重定向来通过该加速域名获取资源);
|
||||
* 修改配置文件下 `dev` 项配置:
|
||||
* `currentAbPath` 为本项目绝对路径地址;
|
||||
* `cadDwgConverterAbPath` 为本地CAD Dwg转换器执行程序文件夹绝对路径,转换程序使用 libreDWG(已包含在项目static/lib/libredwg文件夹);
|
||||
* `temporaryFolder` 为临时文件夹地址,推荐配置为本项目地址下的`static/tmp`文件夹;
|
||||
|
||||
## 运行
|
||||
|
||||
### 方式一
|
||||
> IDEA中直接运行@SpringBootApplication注解的类的main方法: <br />
|
||||
> `astral-web/src/main/java/com.astral.web/AstralWebApplication/AstralWebApplication`
|
||||
|
||||
### 方式二
|
||||
> cmd中执行命令 `mvn spring-boot:run`
|
||||
|
||||
### 方式三(打包)
|
||||
> cmd中执行命令:
|
||||
> * 生成jar包: mvn clean package
|
||||
> * 进入生成的jar包目录:cd astral-web/target
|
||||
> * 运行项目:java -jar astral-web-exec.jar
|
||||
|
||||
## Star History
|
||||
[](https://star-history.com/#yx8663/astral-service&Date)
|
||||
# AstralService
|
||||
|
||||
🌍 *[简体中文](README.md)* | English
|
||||
|
||||
Backend service for NeonVision 3D Editor.
|
||||
|
||||
Based on `Java 8` and `SpringBoot 2.7.18`.
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
## 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.
|
||||
|
||||
Reference in New Issue
Block a user