dgiot/README.md

122 lines
6.0 KiB
Markdown
Raw Normal View History

2021-07-02 18:09:14 +08:00
# DGIOT
2021-05-30 17:15:32 +08:00
[![GitHub Release](https://img.shields.io/github/release/dgiot/dgiot?color=brightgreen)](https://github.com/dgiot/dgiot/releases)
[![Build Status](https://travis-ci.org/dgiot/dgiot.svg)](https://travis-ci.org/dgiot/dgiot)
[![Coverage Status](https://coveralls.io/repos/github/dgiot/dgiot/badge.svg)](https://coveralls.io/github/dgiot/dgiot)
[![Docker Pulls](https://img.shields.io/docker/pulls/dgiot/dgiot)](https://hub.docker.com/r/dgiot/dgiot)
2021-05-30 17:36:32 +08:00
[![Community](https://img.shields.io/badge/Community-DGIOT-yellow)](https://tech.iotn2n.com)
2021-05-30 17:15:32 +08:00
2021-07-02 19:14:01 +08:00
[English](./README.md) | [简体中文](./README-CN.md) | [日本語](./README-JP.md) | [русский](./README-RU.md)
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
*DGIOT* is the first lightweight open source industrial IoT continuous integration platform in China
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
Before 2016, the Shuwa team had been crawling on the Internet and the mobile Internet for many years. In 2016, it began to enter the Internet of Things crawling. It hopes to share many years of crawling experience through this open source platform and make multidisciplinary industrial Internet projects easier.
+ Let rich engineers to complete industrial Internet projects with simpler requirements through window interaction
+ Let the majority of junior front-end engineers to undertake industrial Internet projects with more complex requirements through the serverless method
+ Let Python, Java, Go, C junior background engineers undertake complex industrial Internet projects through web programming development channels
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
# Vision
The DGIOT team hopes to achieve the following visions through the Shuwa Industrial Internet continuous integration platform
+ Through engineers, front-end engineers, and junior back-office engineers to actually complete small and medium-sized industrial Internet projects in no more than 1 month
+ Ensure high-quality delivery through multiple methods such as open source code, free software, document sharing, technical certification, product certification, operation and maintenance hosting, etc.
+ Experts in the technical field continue to integrate the industry's excellent technical framework, and experts in the business field continue to optimize business models and processes, and build a multidisciplinary open platform
+ The IoT platform can finally be simple and easy to use, returning to the essence of tooling
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
# Building
2021-05-30 17:32:29 +08:00
2021-09-09 14:36:30 +08:00
Bulid *DGIOT* Need Erlang/OTP R21+, Windows download [msys64.rar](http://dgiot-1253666439.cos.ap-shanghai-fsi.myqcloud.com/msys64/msys64.zip) ,After downloading, unzip it to the root directory of Disk D, and operate strictly in accordance with the following figure
2021-08-06 11:02:57 +08:00
![效果图-1.png](http://dgiot-1253666439.cos.ap-shanghai-fsi.myqcloud.com/msys64/%E6%95%88%E6%9E%9C%E5%9B%BE-1.png))
2021-06-30 13:45:56 +08:00
2021-07-02 18:06:58 +08:00
+ Download source code abroad
2021-06-17 18:34:17 +08:00
```bash
git clone https://github.com/dgiot/dgiot_dashboard.git
git clone https://github.com/dgiot/dgiot.git
```
2021-07-02 18:06:58 +08:00
+ China download source code
2021-06-17 18:34:17 +08:00
```bash
git clone https://gitee.com/dgiiot/dgiot_dashboard.git
2021-07-02 17:50:41 +08:00
git clone https://gitee.com/dgiiot/dgiot.git
2021-06-17 18:34:17 +08:00
```
2021-07-02 18:06:58 +08:00
+ China Linux/Unix/Mac/windows Build
2021-06-17 18:34:17 +08:00
```bash
cd dgiot_dashboard
2021-06-22 19:28:39 +08:00
git pull
2021-07-28 16:36:06 +08:00
yarn dgiot:install
2021-06-17 18:34:17 +08:00
yarn build
cd ../dgiot
2021-06-22 19:28:39 +08:00
git pull
2021-06-22 18:26:46 +08:00
rm ./apps/dgiot_api/priv/www -rf
2021-06-18 09:11:36 +08:00
cp ../dgiot_dashboard/dist/ ./apps/dgiot_api/priv/www -rf
cp ../dgiot_dashboard/swagger ./apps/dgiot_api/priv/www/ -rf
2021-06-21 13:44:46 +08:00
make run
2021-06-21 09:30:47 +08:00
```
2021-06-21 13:44:46 +08:00
+ Make Debug
2021-06-21 09:30:47 +08:00
```
2021-06-21 13:44:46 +08:00
make DIAGNOSTIC=1
2021-06-21 09:30:47 +08:00
```
2021-07-02 18:09:14 +08:00
*DGIOT* start, you can use a browser to visit http://localhost:5080 to view Dashboard.。
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
- For a complete list of new features, see [DGIOT Release Notes](https://github.com/dgiot/dgiot/releases)。
- For more information, please visit [DGIOT Website](https://tech.iotn2n.com/)。
2021-09-09 12:35:58 +08:00
## Installation and deployment
+ **centos 7.6**
2021-09-08 19:14:09 +08:00
```
2021-09-09 14:18:26 +08:00
wget https://cdn.jsdelivr.net/gh/dgiot/dgiot@master/dgiot_install.sh && sh dgiot_install.sh
2021-09-08 19:14:09 +08:00
```
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
## Community
2021-05-30 17:15:32 +08:00
### FAQ
2021-07-02 18:06:58 +08:00
Visit [DGIOT FAQ](https://tech.iotn2n.com/en/backend/) to get help on frequently asked questions
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
### FAQ
2021-05-30 17:15:32 +08:00
[GitHub Discussions](https://github.com/dgiot/dgiot_server/discussions)
2021-07-02 18:06:58 +08:00
[DGIOT Chinese Q&A Community](https://tech.iotn2n.com/)
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
### Involved in the design
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
If you have suggestions for improvements to DGIOT, you can submit PR and ISSUE to [EIP](https://github.com/dgiot/eip)
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
### Plug-in development
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
If you want to integrate or develop your own plug-in, refer to [lib-extra/README.md](./lib-extra/README.md)
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
You are welcome to submit any bugs, issues and feature requests to [dgiot/dgiot](https://github.com/dgiot/dgiot/issues)。
2021-05-14 07:28:48 +08:00
2021-07-02 18:06:58 +08:00
### About Us
| contact details | address |
2021-05-14 07:36:54 +08:00
| -------------- | ----------------------------------------------------------------------------------------- |
2021-05-22 02:06:00 +08:00
| github | [https://github.com/dgiot](https://github.com/dgiot?from=git) |
2021-05-14 07:36:54 +08:00
| gitee | [https://gitee.com/dgiot](https://gitee.com/dgiiot?from=git) |
2021-07-02 18:06:58 +08:00
| Official website | [https://www.iotn2n.com](https://www.iotn2n.com?from=git) |
| Blog | [https://tech.iotn2n.com](https://tech.iotn2n.com?from=git) |
| IoT access platform | [https://dgiot.iotn2n.com](https://dgiot.iotn2n.com?from=git) |
| The public | ![qrcode.png](http://dgiot-1253666439.cos.ap-shanghai-fsi.myqcloud.com/wechat/qrcode.png) |
2021-05-30 17:15:32 +08:00
2021-07-02 18:06:58 +08:00
### Contact us
You can contact the DGIOT community and developers through the following channels:
2021-05-30 17:15:32 +08:00
- [Slack](https://slack-invite.dgiot.com)
- [Twitter](https://twitter.com/dgiotTech)
- [Facebook](https://www.facebook.com/dgiot)
- [Reddit](https://www.reddit.com/r/dgiot/)
- [Weibo](https://weibo.com/dgiot)
- [Blog](https://www.dgiot.cn/blog)
2021-07-02 18:06:58 +08:00
## Preview address
[Tencent Cloud preview address](https://dgiotdashboard-8gb17b3673ff6cdd-1253666439.ap-shanghai.app.tcloudbase.com?ftom=git)
2021-05-30 17:47:11 +08:00
2021-07-02 18:06:58 +08:00
## Scan code preview
2021-05-30 17:47:11 +08:00
![dgiot_dashboard.png](http://dgiot-1253666439.cos.ap-shanghai-fsi.myqcloud.com/wechat/dgiot_dashboard.png)
2021-07-02 18:06:58 +08:00
## Open source license
2021-05-30 17:15:32 +08:00
Apache License 2.0, 详见 [LICENSE](./LICENSE)。