Skip to content

Commit 8d5d0a2

Browse files
Haoke98Haoke98
committed
新增英文README文档
Signed-off-by: Sadam·Sadik <1903249375@qq.com>
1 parent a203301 commit 8d5d0a2

File tree

1 file changed

+208
-0
lines changed

1 file changed

+208
-0
lines changed

‎README.en_US.md

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
# DjangoAsyncAdmin
2+
3+
DjangoAsyncAdmin is a new dynamic admin interface for Django, featuring asynchronous requests, asynchronous page updates and loading, and a more attractive UI. It is based on vue2+ElementUI2.X and is a simple and efficient solution for high-performance backend management.
4+
5+
This project is based on [`SimplePro:6.5.2`](https://github.com/newpanjing/simplepro) and is open-source, with no licensing or activation required.
6+
7+
[![](https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Haoke98/DjangoAsyncAdmin)
8+
[![Gitee](https://img.shields.io/badge/Gitee-C71D23?style=for-the-badge&logo=gitee&logoColor=white)](https://gitee.com/sadam98/DjangoAsyncAdmin)
9+
![](https://img.shields.io/badge/Django-092E20?style=for-the-badge&logo=django&logoColor=white)
10+
![](https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vue.js&logoColor=4FC08D)
11+
![](https://img.shields.io/badge/Google_chrome-4285F4?style=for-the-badge&logo=Google-chrome&logoColor=white)
12+
13+
![](https://img.shields.io/github/followers/Haoke98.svg?style=social&label=Follow&maxAge=2592000)
14+
![](https://img.shields.io/github/license/Haoke98/DjangoAsyncAdmin.svg)
15+
![](https://img.shields.io/github/downloads/Haoke98/DjangoAsyncAdmin/total.svg)
16+
![](https://img.shields.io/github/forks/Haoke98/DjangoAsyncAdmin.svg)
17+
![](https://img.shields.io/github/stars/Haoke98/DjangoAsyncAdmin.svg)
18+
![](https://img.shields.io/github/watchers/Haoke98/DjangoAsyncAdmin.svg)
19+
![GitHub language count](https://img.shields.io/github/languages/count/Haoke98/DjangoAsyncAdmin)
20+
![GitHub search hit counter](https://img.shields.io/github/search/Haoke98/DjangoAsyncAdmin/django)
21+
![GitHub top language](https://img.shields.io/github/languages/top/Haoke98/DjangoAsyncAdmin)
22+
![GitHub contributors](https://img.shields.io/github/contributors/Haoke98/DjangoAsyncAdmin)
23+
24+
![](http://ForTheBadge.com/images/badges/made-with-python.svg)
25+
[![forthebadge](https://haoke98.github.io/DjangoAsyncAdmin/static/MADE%20WITH-JetBrains-PyCharm.svg)](https://forthebadge.com)
26+
27+
## Inspiration
28+
* thinkPHP
29+
* simpleUI
30+
* simplePro
31+
32+
## Demo
33+
* [Digital World](https://github.com/Haoke98/AllKeeper)
34+
![](https://haoke98.github.io/DjangoAsyncAdmin/static/digital_world_banner.png)
35+
* [AI Lab](#)
36+
![](https://haoke98.github.io/DjangoAsyncAdmin/static/silk_road_ai_banner.png)
37+
38+
## Features
39+
<table>
40+
<tr><td>Feature</td><td>Sub-Feature</td><td>Sub-Sub-Feature</td><td>Status</td></tr>
41+
<tr><td>Optimized List Pages</td><td>Separated Front-End and Back-End Loading of Data</td><td>·········</td><td>✅</td></tr>
42+
<tr><td>Visualized Homepage Design</td><td>·········</td><td>·········</td><td>✅</td></tr>
43+
<tr><td>Multiple Customizable Theme Skins</td><td>·········</td><td>·········</td><td>✅</td></tr>
44+
<tr><td rowspan="8">Rich Component Library</td><td>Integration of Almost All Element-UI Components</td><td>·········</td><td>✅</td></tr>
45+
<tr><td rowspan="3">Diverse Kinds of Editors</td><td>Rich Text Editor</td><td>✅</td></tr>
46+
<tr><td>Markdown Editor</td><td>✅</td></tr>
47+
<tr><td>Json Editor</td><td>✅</td></tr>
48+
<tr>
49+
<td rowspan="2">Media Components</td>
50+
<td>Image Upload Component</td><td>✅</td>
51+
</tr>
52+
<tr><td>Video Playback Component</td><td>✅</td></tr>
53+
<tr><td rowspan="2">Advanced Components</td><td>Map Component</td><td>✅</td></tr>
54+
<tr><td>Password Input Component</td><td>✅</td></tr>
55+
<tr><td rowspan="4">Supports Customization</td><td>Custom Buttons</td><td>·········</td><td>✅</td></tr>
56+
<tr><td>Custom Menus</td><td>·········</td><td>✅</td></tr>
57+
<tr><td>Custom Permissions</td><td>·········</td><td>✅</td></tr>
58+
<tr><td>Custom Dialog Boxes</td><td>·········</td><td>✅</td></tr>
59+
<tr><td>·········</td><td>·········</td><td>·········</td><td>✅</td></tr>
60+
<tr><td>Optimized Permissions</td><td>·········</td><td>·········</td><td>✅</td></tr>
61+
</table>
62+
63+
## Usage
64+
### Basics
65+
* Component Documentation [DjangoAsyncAdmin Components Docs](https://haoke98.github.io/DjangoAsyncAdmin/components.html)
66+
* Packaging and Deployment Documentation [Package And Deploy](https://haoke98.github.io/DjangoAsyncAdmin/build.html)
67+
* Installation and Configuration [Temporary Reference](https://www.mldoo.com/docs/simplepro/guide/project_config.html)
68+
### Advanced Configuration
69+
* Global Configuration [Temporary Reference](https://www.mldoo.com/docs/simplepro/config/global/)
70+
* Admin Configuration [Temporary Reference](https://www.mldoo.com/docs/simplepro/config/admin/field.html)
71+
* Theme Configuration [Temporary Reference](https://www.mldoo.com/docs/simplepro/config/theme.html)
72+
* JS-SDK [Temporary Reference](https://www.mldoo.com/docs/simplepro/config/jssdk.html)
73+
* Custom Permissions [Temporary Reference](https://www.mldoo.com/docs/simplepro/config/permissions.html)
74+
* Visualization Icons [Temporary Reference](https://www.mldoo.com/docs/simplepro/config/chat.html)
75+
* Rich Text Plugins [Temporary Reference](https://www.mldoo.com/docs/simplepro/config/editor.html)
76+
77+
### Frequently Asked Questions
78+
* Static files [temporary reference](https://www.mldoo.com/docs/simplepro/faq/static.html)
79+
* Installation problems [temporary reference](https://www.mldoo.com/docs/simplepro/faq/install.html)
80+
* Installation problems [temporary reference](https://www.mldoo.com/docs/simplepro/faq/install.html)
81+
82+
### Installation
83+
#### pip installation
84+
```shell
85+
pip install DjangoAsyncAdmin
86+
```
87+
>If your installation is slow, you can use the mirror provided by the University of Science and Technology of China to speed up
88+
```shell
89+
pip install DjangoAsyncAdmin -i https://pypi.mirrors.ustc.edu.cn/simple/
90+
```
91+
#### Source code installation
92+
##### 1. Clone the project to local
93+
```shell
94+
git clone https://github.com/Haoke98/DjangoAsyncAdmin.git
95+
```
96+
##### 2. Generate installation package
97+
Enter the project root directory
98+
99+
```shell
100+
python setup.py sdist bdist_wheel
101+
```
102+
103+
##### 3. Install
104+
105+
```shell
106+
pip install /path/to/your_project/dist/DjangoAsyncAdmin-6.5.4.tar.gz
107+
```
108+
109+
Note: ⚠️ Replace `/path/to/your_project` with your project path (relative path/absolute path)
110+
111+
## Directory structure description
112+
113+
| Directory | Remarks |
114+
|--------------|-----------------------------------|
115+
| bawa | |
116+
| components | Components, store model fields and form fields
117+
| editor | Editor, MD editor, UE rich text editor, JSON editor, etc.
118+
| group | |
119+
| locale | Multiple language package directory, plaintext and binary files do not need to be processed
120+
| management | |
121+
| monitor | |
122+
| static | Static resource directory, no need to process
123+
| templates | Template directory, no need to process
124+
| templatetags | |
125+
| \_\_init\_\_.py | |
126+
| action.py | |
127+
| apps.py | |
128+
| apps.py | |
129+
| conf.py | |
130+
| conf.py | |
131+
| core.so | Converted and saved to core.py
132+
| decorators.py| |
133+
| dialog.py | |
134+
| filters.py | |
135+
| forms.py | |
136+
| hanlers.py | Removed the part that loads the core.so file and added `from core.py import *`
137+
| middlewares.py| |
138+
| models.py | Basic model file |
139+
| urls.py | |
140+
| utils.py | |
141+
142+
## New feature log
143+
<table>
144+
<tr>
145+
<td>Version</td><td colspan="2">Description</td>
146+
</tr>
147+
148+
<tr>
149+
<td rowspan="1">6.7.3</td>
150+
<td colspan="2">Fixed rendering abnormalities on the password component (PasswordInputField).</td>
151+
</tr>
152+
153+
<tr>
154+
<td rowspan="2">6.7.2</td>
155+
<td colspan="2">Implemented the Json editor (JsonTextField) and password generator Input (PasswordInputField) and other components. At the same time, the component directory structure was preliminarily adjusted to improve the readability of the code.</td>
156+
</tr>
157+
<tr>
158+
<td colspan="2"><img src="https://haoke98.github.io/DjangoAsyncAdmin/static/json_text_field.png"/></td>
159+
</tr>
160+
161+
162+
163+
<tr>
164+
<td rowspan="2">6.7.1</td>
165+
<td colspan="2">Added the PasswordFormField form fields with copy and automatic password generation.</td>
166+
</tr>
167+
<tr>
168+
<td colspan="2"><img src="https://haoke98.github.io/DjangoAsyncAdmin/static/截屏2023-11-15%2016.20.58.png"/></td>
169+
</tr>
170+
171+
172+
<tr>
173+
<td>6.7.0</td>
174+
<td colspan="2">Added basic classes BaseModel and BaseModelWithShowRate to reduce the repetitive design of some basic fields and attributes during the development process, and improve the efficiency of designing models.</td>
175+
</tr>
176+
177+
178+
<tr>
179+
<td>6.6.0</td>
180+
<td colspan="2">Removed the authorization and activation state validation mechanism to make it fully authorized, activated, and free to use for academic research. You can also apply for a free commercial use license. For licensing, cooperation, and other issues, please contact <1903243975@qq.com>.</td>
181+
</tr>
182+
183+
184+
<tr>
185+
<td rowspan="2">6.5.4</td>
186+
<td colspan="2">Upgraded and optimized the display of the title and LOGO on the login page of the background management.</td>
187+
</tr>
188+
<tr>
189+
<td><img src="https://haoke98.github.io/DjangoAsyncAdmin/static/%E6%88%AA%E5%B1%8F2023-10-07%2005.15.43.png"/></td>
190+
<td><img src="https://haoke98.github.io/DjangoAsyncAdmin/static/%E6%88%AA%E5%B1%8F2023-10-07%2005.04.21.png"></td>
191+
</tr>
192+
193+
<tr>
194+
<td>6.5.3</td>
195+
<td colspan="2">Implemented the effect that the table header and the total column at the bottom of the table list page are fixed and the table bodyscroll.</td>
196+
</tr>
197+
198+
</table>
199+
200+
## Open source license
201+
202+
The code in this repository is open source under the Apache-2.0 license. This project is completely open to academic research and can also apply for a free commercial use license. For licensing, cooperation, and other issues, please contact <1903243975@qq.com>.
203+
204+
## Acknowledgments & References
205+
206+
Thanks to [newpanjing](https://github.com/newpanjing/simpleui) for simpleui
207+
208+
Thanks to [newpanjing](https://github.com/newpanjing/simplepro) for simplepro

0 commit comments

Comments
 (0)