diff --git a/README.md b/README.md index a469bb9b2..c743b195c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - - - -## [文档和规范] - -#### [项目结构描述](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/project_structure.md) -#### [Python代码规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/python_style_guide.md) -#### [API设计规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/api_style_guide.md) - + + +## [文档和规范] + +#### [项目结构描述](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/project_structure.md) +#### [Python代码规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/python_style_guide.md) +#### [API设计规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/api_style_guide.md) +#### [表结构](https://code.simcu.com/jumpserver/jumpserver/wikis/table_structure_image) + diff --git a/docs/README.md b/docs/README.md index ffce0876b..a3698f4c9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,2 +1,4 @@ -## [代码规范](/jumpserver/jumpserver/blob/master/docs/code_style.md) -## [项目结构](/jumpserver/jumpserver/blob/master/docs/project_structure.md) \ No newline at end of file +#### [项目结构描述](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/project_structure.md) +#### [Python代码规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/python_style_guide.md) +#### [API设计规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/api_style_guide.md) +#### [表结构](https://code.simcu.com/jumpserver/jumpserver/wikis/table_structure_image) \ No newline at end of file diff --git a/docs/project_structure.md b/docs/project_structure.md index 68bc6edbd..301f2f1a9 100644 --- a/docs/project_structure.md +++ b/docs/project_structure.md @@ -1,41 +1,42 @@ -## 项目骨架 - -说明如下: - -``` -. -├── config-example.py // 配置文件样例 -├── docs // 所有doc文件放到该目录 -│ └── README.md -├── LICENSE -├── README.md -├── install // 安装说明 -├── logs // 日志目录 -├── dashboard // 管理后台目录,也是各app所在目录 -│ └── assets // app目录 -│ │ ├── admin.py -│ │ ├── apps.py // 新版本django app设置文件 -│ │ ├── api.py // api文件 -│ │ ├── __init__.py -│ │ ├── migrations // models Migrations版本控制目录 -│ │ │ └── __init__.py -│ │ ├── models.py // 数据模型目录 -│ │ ├── static // app下静态资源目录,如果需要 -│ │ │ └── assets // 多一层目录,防止资源重名 -│ │ │ └── some_image.png -│ │ ├── templates // app下模板目录 -│ │ │ └── assets // 多一层目录,防止资源重名 -│ │ │ └── asset_list.html -│ │ ├── templatetags // 模板标签目录 -│ │ ├── tests.py // 测试用例文件 -│ │ ├── urls.py // urlconf文件 -│ │ ├── utils.py // 将views和api可复用的代码放在这里, api和views只是请求和返回不同 -│ │ └── views.py // views文件 -│ ├── jumpserver // 项目设置目录 -│ │ ├── __init__.py -│ │ ├── settings.py // 项目设置文件 -│ │ ├── urls.py // 项目入口urlconf -│ │ └── wsgi.py -│ ├── manage.py -│ ├── static // 项目静态资源目录 -│ └── templates \ No newline at end of file +## 项目骨架 + +说明如下: + +``` +. +├── config-example.py // 配置文件样例 +├── docs // 所有doc文件放到该目录 +│ └── README.md +├── LICENSE +├── README.md +├── install // 安装说明 +├── logs // 日志目录 +├── dashboard // 管理后台目录,也是各app所在目录 +│ └── assets // app目录 +│ │ ├── admin.py +│ │ ├── apps.py // 新版本django app设置文件 +│ │ ├── api.py // api文件 +│ │ ├── __init__.py +│ │ ├── migrations // models Migrations版本控制目录 +│ │ │ └── __init__.py +│ │ ├── models.py // 数据模型目录 +│ │ ├── static // app下静态资源目录,如果需要 +│ │ │ └── assets // 多一层目录,防止资源重名 +│ │ │ └── some_image.png +│ │ ├── templates // app下模板目录 +│ │ │ └── assets // 多一层目录,防止资源重名 +│ │ │ └── asset_list.html +│ │ ├── templatetags // 模板标签目录 +│ │ ├── tests.py // 测试用例文件 +│ │ ├── urls.py // urlconf文件 +│ │ ├── utils.py // 将views和api可复用的代码放在这里, api和views只是请求和返回不同 +│ │ └── views.py // views文件 +│ ├── jumpserver // 项目设置目录 +│ │ ├── __init__.py +│ │ ├── settings.py // 项目设置文件 +│ │ ├── urls.py // 项目入口urlconf +│ │ └── wsgi.py +│ ├── manage.py +│ ├── static // 项目静态资源目录 +│ └── templates // 项目模板目录 +``` diff --git a/docs/table_design.xml b/docs/table_design.xml index 91f5cd782..066f1534c 100644 --- a/docs/table_design.xml +++ b/docs/table_design.xml @@ -1,6 +1,6 @@ - + @@ -100,7 +100,7 @@ id - +
INTEGER NULL @@ -114,7 +114,7 @@ id
- +
INTEGER NULL @@ -131,7 +131,7 @@ id
- +
INTEGER NULL @@ -147,7 +147,7 @@ id
- +
INTEGER NULL @@ -165,7 +165,7 @@ id
- +
INTEGER NULL @@ -179,7 +179,7 @@ id
- +
INTEGER NULL @@ -276,7 +276,7 @@ id
- +
INTEGER NULL @@ -290,7 +290,7 @@ id
- +
INTEGER NULL @@ -344,7 +344,7 @@ id
- +
INTEGER NULL @@ -361,7 +361,7 @@ id
- +
INTEGER NULL @@ -377,7 +377,7 @@ id
- +
INTEGER NULL @@ -412,7 +412,7 @@ id
- +
INTEGER NULL @@ -468,7 +468,7 @@ id
- +
INTEGER NULL @@ -484,7 +484,7 @@ id
- +
INTEGER NULL @@ -534,7 +534,7 @@ id
- +
INTEGER NULL @@ -548,7 +548,7 @@ id
- +
INTEGER NULL @@ -564,7 +564,7 @@ id
- +
INTEGER NULL @@ -580,7 +580,7 @@ id
- +
INTEGER NULL @@ -596,7 +596,7 @@ id
- +
INTEGER NULL @@ -612,7 +612,7 @@ id
- +
INTEGER NULL @@ -641,17 +641,14 @@ id
- +
INTEGER NULL DATETIME NULL - -DATETIME -NULL - + CHAR NULL @@ -660,12 +657,110 @@ CHAR NULL - + +CHAR +NULL + +CHAR +NULL + +id + +
+ + INTEGER NULL + +CHAR +NULL + +CHAR +NULL + +CHAR +NULL + +CHAR +NULL + +INTEGER +NULL + +CHAR +NULL + +VARCHAR +NULL + +VARCHAR +NULL + +INTEGER +NULL + +DATETIME +NULL + +DATETIME +NULL + +id + +
+ + +INTEGER +NULL + +INTEGER +NULL + + +DATE +NULL + +CHAR +NULL + +id + +
+ + +INTEGER +NULL + +INTEGER +NULL + + +INTEGER +NULL + + +CHAR +NULL + +VARCHAR +NULL + +VARCHAR +NULL + +VARCHAR +NULL + +INTEGER +NULL + +DATETIME +NULL + +TIME +NULL id
- diff --git a/install/example.sh b/install/example.sh new file mode 100644 index 000000000..e69de29bb diff --git a/logs/example.log b/logs/example.log new file mode 100644 index 000000000..e69de29bb