diff --git a/README.en.md b/README.en.md index cc0ca4bb2f1ee864cd694a85a860d694c627aa46..d5f8e2a9723286e2d6e58181a3b7c96b77d16249 100644 --- a/README.en.md +++ b/README.en.md @@ -1,63 +1,70 @@ # EnjoyVIID #### Description -1400视图库平台 + +1400 video gallery platform #### Software Architecture + Software architecture description #### Installation -1. xxxx -2. xxxx -3. xxxx +1. First use git to clone the project to the local, project address: https://gitee.com/tsingeye/EnjoyVIID.git +2. Use the enjoyviid.sql file provided by this project to create a new local database. The enjoyviid.sql file is located + in the sql folder. +3. Configure the local maven and its warehouse address. +4. Use the maven packaging command to package and deploy, and the packaged project is enjoy-viid.jar. +5. Use the java -Xms1g -Xmx1g -jar enjoy-viid.jar command to deploy the project. #### Instructions -1. xxxx -2. xxxx -3. xxxx +1. JDK version 1.8 and above. +2. My Sql version 8.0 and above. #### Contribution -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request - +1. Fork the repository +2. Create Feat_xxx branch +3. Commit your code +4. Create Pull Request #### Gitee Feature -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) - +1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md +2. Gitee blog [blog.gitee.com](https://blog.gitee.com) +3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) +4. The most valuable open source project [GVP](https://gitee.com/gvp) +5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) +6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +## Introduction to the platform +* The back end adopts Spring Boot, Mybatis-plus, Shiro. +* Used lombok. +* Shiro is used for authentication and authorization. Since user management and other functions are not required in this + system, only login authentication is performed, and authorization is written as admin in the code. +* The functions that have been completed include device access registration, device access keep-alive, device access + cancellation, and storage functions. +* Other businesses need to build and design their own tables during development. -## 平台简介 -* 后端采用SpringBoot、Mybatis-plus、Shiro。 -* 使用了lombok -* 认证授权使用Shiro,本系统中由于不需要用户管理等功能,所有只做了登录认证,授权写死在代码里为admin。 -* 已完成的有设备接入注册、设备接入保活、设备接入注销、以及存储功能。 -* 其他业务需要在开发时自建表和设计表。 +## Built-in function -## 内置功能 ```text -1. 设备接入注册:是用来给拍摄人脸及其他图片的设备进行接入注册。 -2. 设备接入保活:给已经接入的设备进行保活操作。 -3. 设备接入注销:已经接入注册的设备允许其自动注销。 -4. 存储:将设备传输过来的图片存储到本系统的minio中。 +1. Device access registration: It is used to access and register the devices that take human faces and other pictures. +2. Device access keep-alive: Keep-alive operations for devices that have been connected. +3. Device access deregistration: The registered device is allowed to logout automatically. +4. Storage: Store the pictures transferred from the device to the minio of the system. ``` -## 服务端代码启动 -***windows系统:java -Xms1g -Xmx1g -jar enjoyvds-1.0-SNAPSHOT.jar*** - -## 需对外接口 -1. 登录、登出 -2. 获取设备列表 -3. 订阅设备消息 -4. 查询历史图片 -5. 系统统计展示 + +## Server code start + +***windows system:java -Xms1g -Xmx1g -jar enjoyvds-1.0-SNAPSHOT.jar*** + +## External interface required + +1. Sign in, sign out. +2. Get device list. +3. Subscribe to device news. +4. Query historical pictures. +5. System statistics display. diff --git a/README.md b/README.md index 628cc9e6b711ab71854681c0ac5774cd03038cf8..fe7eb7e2a5da2f16e13a7a6e10fbe3fd822371f2 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ #### 软件架构 - 开发语言基于Java - 存储基于minio +- 缓存基于redis #### 功能 @@ -24,9 +25,8 @@ #### 使用说明 -1. xxxx -2. xxxx -3. xxxx +1. JDK版本1.8及以上 +2. MySql版本8.0及以上 #### 参与贡献