# mySample

**Repository Path**: ceogo/my-sample

## Basic Information

- **Project Name**: mySample
- **Description**: my-sample personal
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-02-27
- **Last Updated**: 2024-03-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MySample

### 主要目录一览
/src (后端的源代码目录)  
/docker (存放容器构建及运行脚本指令)  
/app  (存放终端项目代码文件目录)  
-- /app/web (web前端目录)  
-- /app/android (android前端目录)

### 开发环境准备
1. java-jdk 1.8+
2. node 21.0+  https://nodejs.org/en
   国内需要使用npm的国内镜像源  npm config set registry http://mirrors.cloud.tencent.com/npm/
3. git https://git-scm.com/downloads
4. gradle 6.8+  https://gradle.org/releases/

### 软件架构
#### 开发依赖及运行环境管理
1.使用 Grade 来做后端与 Android 端的开发依赖及编译过程管理, 如果使用 idea,需要将项目的 gradle 设置为 Use Gradle from gradle-wrapper.properties  

2.前端使用 Vue3 来进行前端的基础开发,其中使用 vite 来做前端的运行环境编译管理

#### 构建及编译运行指导
1. 后端:  
   1.1 如有设置系统 gradle 的运行路径,则可以在主目录下使用 ```gradle bootRun``` (这个运行是包含了重新编译的代码修改)  
   1.2 如果没有 gradle 环境，则使用ide的插件来执行  
   1.3 使用主目录 /dist 下的jar包直接运行 ```java -jar book-1.0.jar```
   1.4 后端一旦运行后会在同目录下创建或使用 book.db 来作为 sqlLite 的数据库存储文件
   1.5 默认端口 ```555``` 设置在 application.yml
   1.6 使用 ```gradle build``` 可以创建200条数据，具体实现在 org.example.sys.DataTests
   1.7 打包使用 ```gradle bootjar``` 会在 build/libs 下创建 book-starter-x.x.jar
2. 前端  
   2.1 安装依赖: ```npm install```  
   2.2 运行服务: ```npm run dev``` (dev下使用的 .env.development 指定下的 api 和 host ,默认端口 ```333``` 设置在 .env)  
   2.3 打包发布: ```npm run build``` 

3. Android 端 
   指定 API 服务的 http 地址在代码 org.example.sys.App 里设置, 一般需要修改指向重新编译后才能使用
   
4. Docker 
  4.1 镜像构建: 在 docker 目录选择不同版本的镜像执行 Dockerfile 文件， ```docker build -t node21-jdk8-alpine:1.0 . --squash ```  
  4.2 运行容器: 如: ```docker run -itd -p 555:555 --privileged=true --restart unless-stopped --name node21-jdk8-alpine node21-jdk8-alpine1.0```

#### 使用教程

1. 源码使用  
  >> git clone https://gitee.com/ceogo/my-sample.git  
  > 
  >> gradle build && gradle bootrun
  > 
  >> cd app/web && npm run dev  

2. 环境使用
>> cd app/web && npm run build
> 
> 上述指令会构建出web端的发布,然后我们把src里的yaml拷贝到dist目录,在追加静态目录的配置，这样可以不用多开前端服务就直接访问
>> spring  
>     mvc:  
>        static-path-pattern: /**  
>     resources:/**  
>        static-locations: xxx/dist,classpath:/static
> 
>> cd app/dist & java -jar book-stater-1.0.jar

3. 镜像使用  
   参照构建及编译运行指导4
   
4. 访问地址  
   http://localhost:555 

#### 快照
![Frontend](snapshot/img1.png)
![Android](snapshot/img2.png)