smartchart/README.md
2021-01-03 16:31:59 +08:00

228 lines
10 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[Wiki](https://gitee.com/smartchart/django_smartchart/wikis/pages) \|
[Community](https://www.smartchart.cn/) \|
[Sponsors](https://www.smartchart.cn/) \|
[GitHub](https://github.com/JohnYan2017/Echarts-Django) \|
[Gitee](https://gitee.com/smartchart/django_smartchart)
<p align="center">
<a href="https://www.smartchart.cn"><img src="https://www.smartchart.cn/static/index/logo8.png" width="45%"></a>
</p>
<p align="center">
<strong>A platform that Connect Data to Echarts.</strong>
</p>
<p align="center">
<a href="https://www.smartchart.cn">https://www.smartchart.cn</a>
</p>
<p align="center">
<img src="https://img.shields.io/badge/Release-V3.9.8-green.svg" alt="Downloads">
<a target="_blank" href="https://www.python.org/downloads/release/python-390/">
<img src="https://img.shields.io/badge/Python-3.6+-green.svg" />
</a>
<a href='https://gitee.com/smartchart/django_smartchart/members'><img src='https://gitee.com/smartchart/django_smartchart/badge/fork.svg?theme=dark' alt='fork'></a>
<a href='https://gitee.com/smartchart/django_smartchart/stargazers'><img src='https://gitee.com/smartchart/django_smartchart/badge/star.svg?theme=dark' alt='star'></a>
<a target="_blank" href='https://github.com/JohnYan2017/Echarts-Django'>
<img src="https://img.shields.io/github/stars/JohnYan2017/Echarts-Django.svg?style=social" alt="github star"/>
</a>
</p>
<p align="center">
<a href="https://qm.qq.com/cgi-bin/qm/qr?k=eC34KwVvEtMvfh8Zyn1RSfYlzZvuvm7i&jump_from=webapi"><img src="https://img.shields.io/badge/QQ群-476715246-orange"/></a>
<a target="_blank" href="https://www.smartchart.cn">
<img src="https://img.shields.io/badge/Author-John%20Yan-ff69b4.svg" alt="Downloads">
</a>
<a target="_blank" href="https://www.smartchart.cn">
<img src="https://img.shields.io/badge/Copyright%20-@smartchart.cn-%23ff3f59.svg" alt="Downloads">
</a>
</p>
-------------------------------------------------------------------------------
[**English Documentation**](README-EN.md)
-------------------------------------------------------------------------------
### 简介
- Django-SmartChart基于Smartchart/Echarts/Django的微代码开发平台,适用于任何WEB项目
- 简单, 敏捷, 高效,通用化, 高度可定制化, 让你的项目瞬间档次提升, 比拖拽开发更方便
- 完全真正打通前后端, 图形数据联动, 筛选开发毫无压力, 支持几乎常见的所有数据库
- 积木式的开发模式, 开箱即用, 安装简单, 依赖少, 适应各种平台
- 我们让简单和通用化不再是个矛盾体, 请加入我们共建生态, Like it Star it
![舆情分析](https://images.gitee.com/uploads/images/2019/0614/130021_887dc34c_2327318.png "舆情分析.png")
![smartchart](http://smartchart.cn/media/editor/WX20201128-075135@2x_20201128075202927382.png)
![smartchartvoice](http://smartchart.cn/media/editor/smartvoice_20201224085323156045.png)
### 样列
- [SmartChart大屏样列-智慧城市_大数据大屏](https://www.smartchart.cn/echart/?type=智慧城市_大数据大屏 "大屏样列-智慧城市_大数据大屏")
- [SmartChart集成DataV](https://www.smartchart.cn/echart/?type=Smartchart_DataV "集成DATAV")
- [Smartchart图形数据联动](https://www.smartchart.cn/echart/?type=评论分析 "图形数据联动")
- [Smartchart无关重要的视屏](https://www.ixigua.com/6910413586208653837?id=6910161770221044237 "smartchart")
- [Smartchart与Jupyter](https://www.ixigua.com/6912682016601440772/ "smartchart")
### 快速开始
#### 安装Python环境
- 环境准备: 官方[最新Python下载链接](https://www.python.org/downloads/release/python-390/ "最新Python下载链接")
如果下载太慢, 可以到[淘宝镜象下载](https://npm.taobao.org/mirrors/python/3.9.0/ "淘宝镜象下载")
也可以直接下载[WINDOWS64位安装版](https://npm.taobao.org/mirrors/python/3.9.0/python-3.9.0-amd64.exe "WINDOWS64位安装版")
[MAC电脑安装版](http://npm.taobao.org/mirrors/python/3.9.0/python-3.9.0rc2-macosx10.9.pkg "MAC电脑安装版")
- [Window平台安装视屏介绍](https://www.ixigua.com/6910413586208653837?id=6901867671193649668 "Window平台安装视屏介绍")
#### 安装SmartChart
```shell script
pip3 install smartchart
pip3 install smartchart -U (升级)
如果安装过程慢,建意使用
pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple smartchart
如果你是第一次安装SmartChart(注意,非第一次不要执行,会覆盖原有DB)
pip3 install smartdb (初始化DB)
```
#### 快速启动
Window系统中以下命令的 smartchart xxx 使用 smartchart.py xxx 代替
注意: 如果你是Windows系统且安装过pycharm, 你可能需要随意新建一个xx.py的文件,
右键选择打开方式, 改成永久使用python来关联打开
```shell script
本地命令行启动:
smartchart
如果你需要远程访问,启动方式:
smartchart runserver 0.0.0.0:8000 --insecure
```
**访问首页http://127.0.0.1:8000, 点击首页右上方的云图标初始化数据**
**管理员帐号密码: admin/admin, 请及时更改密码**
**开发前建意新建一个非超级管理员帐号(重要),避免改到内置的数据集和图形**
**开发前请 观看视屏说明!!! 重要!! 重要!!**
- [Smartchart数据库与数据集SQL](https://www.ixigua.com/6910413586208653837?id=6902584882958959116 "SQL")
- [Smartchart页面快速布局](https://www.ixigua.com/6910413586208653837?id=6907784122065191438 "布局")
- [Smartchart数据库与图形的对话](https://www.ixigua.com/6910413586208653837?id=6910373199603565063 "布局")
- [SmartChart大屏模板转化](https://www.ixigua.com/6910825442245083660/ "模板")
### 数据库支持说明
- 原生支持的有mysql,sqlite,API,EXCEL数据
- SQL Server 需安装 pip install pymssql
- ORACLE 需安装 pip install cx_Oracle
- GP,Postgrep 需安装 pip install psycopg2
- Impala 需安装 pip install impyla
- ....
### 系统对接方式
```python
# 如果需要你可以采用单点登录的方式与smartchart进行对接嵌入
'/echart/smart_login?id=xxx&stamp=xxx&token=xxx&url=/'
'''
参数说明:
id: 用户名在smartchart平台中管理
stamp: 时间戳(1970年1月1日到生成时间的毫秒数)
token: 采用sha1加密, token=SHA1(链接秘钥+stamp+id)
链接秘钥默认smartchart,
请在环境变量设定SMART_KEY替换重要
url: 登录成功后跳转链接
'''
# 提示:为了数据安全,对外生产环境使用,务必设定你的环境变量SMART_KEY
```
### 在django项目中当作apps使用
最简单的方法(推荐!!!!)
```shell script
请直接下载gitee/github的项目后
pip install smartchart
启动方式 python manage.py runserver
帐号: admin/amdin
```
如果你动手能力强
```shell script
pip install smartchart
简单配置一下, 你可以参考此demo
资源文件你需要下载gitee/github上的(注意template的setting你要修改成一样)
1. 在你的setting.py的INSTALL_APPS中加入'smart_chart.echart'
2. MIDDLEWARE 中注释掉XFrameOptionsMiddleware
3. setting.py中设定为中国时区, 支持中文基础平台建设!
LANGUAGE_CODE = 'zh-hans'
TIME_ZONE = 'Asia/Shanghai'
USE_I18N = True
USE_L10N = True
USE_TZ = False # 此处必须为False
4. 在你的url.py中加入引用
from django.conf.urls import include
from django.views.generic import RedirectView
5. url.py的urlpatterns中加入路由
path('echart/', include('smart_chart.echart.urls')),
path('', RedirectView.as_view(url='echart/index/')), #首页,可自定义路由
6. 初始化DB, 命令行输入:
python manage.py makemigrations
python manage.py migrate
7. 建立管理员帐号, 如果已有可忽略
python manage.py createsuperuser
8. 启动服务
python manage.py runserver
```
**访问首页http://127.0.0.1:8000, 点击首页右上方的云图标初始化数据**
### 联系我们与帮助
**安装及使用问题,微信群有时效性,可加以下微信号拉你入群**
<img src="https://www.smartchart.cn/media/editor/QQ20201201-140615@2x_20201201140657981573.png" alt="smartchart" height="150" />
你也可以加入QQ群进行普通问题讨论
**QQ群: 476715246 暗号: smartchart**
-------------------------------------------------------------------------------
### 开发指引与声明:
**此项目为前端代码开源可商用(需保留作者信息)**
```shell script
对应的项目目录说明:
templates/echart -- 编辑器界面
templates/index -- 首页Portal
static/echart -- 扩展前端数据处理函数(图形编辑中可用)
static/editor -- 编辑器界面js
static/index -- Portal对应js, css
static/custom -- 你可以在此新建人个文件夹存放自定义css, js, image ..
git clone 项目
pip install smartchart
启动方式 python manage.py runserver
帐号: admin/amdin
```
#### 声明
本项目后端完全免费使用, 开发不易, 为了项目能长期维护下去, 禁止反编译、分发等行为进行商用.
需共同开发后端的同学可以与我联系进入内部项目
#### Change Log
```shell script
2020/12/14 静态资源本地化
v3.9.8.2 支持所有常见数据库,支持VUE,DATAV
v3.9.8.5 支持Jupyter,支持一键分享和应用dashboard模板
```
-------------------------------------------------------------------------------
### 更多使用说明:
**SmartChart designed for you / SmartChart是为你而生的一个产品,**
你只需要使用通用开发技术就可以使用,无需学习特定的技能, 因为她的通用性, 所以让你的知识不会因为改变而淘汰
因为她的灵活性, 你可以充分发挥你的智慧让她变得非常的Smart
抛弃繁琐的操作, 加速你的开发效率, 和BI产品相比, 如同Linux与Window的区别
- 开始使用smart chart, 您不需要任何专业知识, 无需coding, 选择模块组装即可!
- 但如果要使用好smart chart, 建意了解下javascript, H5, Echarts这些前端知识, 可以让你的应用更加得心应手,创作更炫的效果
- 如果你需要更进一步订制你的数据, 你需要了解下SQL的使用,本项目高级应用语言都是通用的技能, 象js, h5,sql 学习成本低
- [SmartChart入门文档入口, 以视屏为准](https://www.smartchart.cn/blog/article/2019/6/1/3.html "SmartChart入门")