Skip to content

Commit 91259ad

Browse files
committed
增加reademe
1 parent 18851b0 commit 91259ad

File tree

2 files changed

+153
-0
lines changed

2 files changed

+153
-0
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 念舊
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Easy.Admin
2+
#### 🌈介绍(喜欢的话给个star吧❤️)
3+
4+
- 后端基于`.NET 8` + `Furion ` + `SqlSugar` + `Vue3` + `TypeScript` ,并且支持多种数据库
5+
- 博客基于`Vue3` + `TypeScript` + `Vuetify` + `Pinia`,分为普通版本和SSR(服务端渲染,支持SEO),服务端渲染框架基于`vite-plugin-ssr`实现
6+
7+
#### ⛱️ 博客在线预览
8+
9+
- 服务端渲染预览:<https://www.okay123.top/>
10+
> 具体部署教程,可以前往博客中查看。<https://www.okay123.top/>
11+
12+
13+
#### 📚后端API使用教程
14+
15+
> 注意:每次修改[`applicationsettings.json`](https://gitee.com/miss_you/easy-admin/blob/master/src/backend/Easy.Admin.Application/applicationsettings.json)中的配置都需要重新生成解决方案方可生效
16+
> 文件所在目录:`/src/backend/Easy.Admin.Application/applicationsettings.json`
17+
18+
1. 可根据需求修改[`applicationsettings.json`](https://gitee.com/miss_you/easy-admin/blob/master/src/backend/Easy.Admin.Application/applicationsettings.json)中的配置文件中的配置,默认使用的sqllite数据库,可修改数据连接字符串更改数据,修改成功后重新生成解决方案,系统会自动创建数据库和初始化基础数据
19+
2. 附件默认上传至站点目录中,可以修改[`applicationsettings.json`](https://gitee.com/miss_you/easy-admin/blob/master/src/backend/Easy.Admin.Application/applicationsettings.json)`OssConnection`节点,支持上传至站点目录以及常用的对象云存储(Minio、腾讯云、阿里云),使用文档:<https://github.com/oncemi/OnceMi.AspNetCore.OSS> ;如果需要使用对象云存储,需将`OssConnection`节点中的`Enable`设置为`true`
20+
3. 缓存默认使用的内置缓存,可修改[`applicationsettings.json`](https://gitee.com/miss_you/easy-admin/blob/master/src/backend/Easy.Admin.Application/applicationsettings.json)中的`easycaching`节点;支持`In-Memory`(默认)、`Redis``Memcached``SQLite``Hybird``Disk``LiteDB`等;使用文档:<https://easycaching.readthedocs.io/en/latest/>
21+
22+
#### ⚡ 注意事项
23+
24+
> 运行后台管理端或者博客前请先检查本地的`node`版本;`node`版本 >= [16](https://nodejs.cn/)
25+
>
26+
> 博客普通版与服务端渲染版UI界面一致,渲染模式有所区别
27+
28+
#### 📚后端管理端使用说明
29+
30+
> 后端管理平台默认账号密码:`admin/123456`;所在目录:`/src/frontend/admin`
31+
32+
``` bash
33+
# 安装依赖
34+
pnpm install
35+
36+
# 运行项目
37+
pnpm run dev
38+
39+
# 打包发布
40+
pnpm run build
41+
```
42+
43+
#### 📚博客普通版使用说明
44+
45+
> 项目所在目录:`/src/frontend/blog`
46+
47+
```bash
48+
# 安装依赖
49+
yarn
50+
51+
# 运行项目
52+
yarn run dev
53+
54+
# 打包发布
55+
yarn run build
56+
```
57+
58+
#### 📚 博客服务端渲染版使用说明
59+
60+
> 服务渲染有两种实现方式
61+
>
62+
> 1、项目所在目录:`/src/frontend/vite-ssr-blog`,基于`vite-plugin-ssr`实现,官方文档:[vite-plugin-ssr](https://cn.vite-plugin-ssr.com/)
63+
>
64+
> 2、项目所在目录:`/src/frontend/blog-nuxt`,基于`nuxtjs`实现,官方文档:[Nuxt](https://nuxt.com/)
65+
66+
```bash
67+
# 安装依赖
68+
yarn
69+
70+
# 运行项目
71+
yarn run dev
72+
73+
# 打包发布
74+
yarn run build
75+
```
76+
77+
#### 📷后端预览图
78+
79+
![image-20230810174459355](https://gitee.com/miss_you/static/raw/master/images/image-20230810174459355.png)
80+
81+
![image-20230810174537064](https://gitee.com/miss_you/static/raw/master/images/image-20230810174537064.png)
82+
83+
![image-20230810174628457](https://gitee.com/miss_you/static/raw/master/images/image-20230810174628457.png)
84+
85+
#### 📷博客预览图
86+
87+
![image-20230810180158798](https://gitee.com/miss_you/static/raw/master/images/image-20230810175841435.png)
88+
89+
![image-20230810174842938](https://gitee.com/miss_you/static/raw/master/images/image-20230810174842938.png)
90+
91+
![image-20230810175305100](https://gitee.com/miss_you/static/raw/master/images/image-20230810175245836.png)
92+
93+
![image-20230810174907977](https://gitee.com/miss_you/static/raw/master/images/image-20230810174907977.png)
94+
95+
![image-20230810174933853](https://gitee.com/miss_you/static/raw/master/images/image-20230810174933853.png)
96+
97+
![image-20230810175004790](https://gitee.com/miss_you/static/raw/master/images/image-20230810175004790.png)
98+
99+
#### 🎉 学习交流加 QQ 群
100+
> QQ群号:647952498
101+
102+
#### 反馈
103+
> 有bug可以在Issues中进行反馈。
104+
105+
#### ❤️ 鸣谢
106+
- 感谢 [JetBrains](https://jb.gg/OpenSourceSupport) 提供的免费开源 License:https://jb.gg/OpenSourceSupport
107+
108+
![JetBrains](src/frontend/image.png)
109+
#### ❤️ 鸣谢
110+
111+
- [Vue](https://cn.vuejs.org/)
112+
113+
- [vite-plugin-ssr](https://cn.vite-plugin-ssr.com/)
114+
115+
- [Furion](http://furion.baiqian.ltd/)
116+
117+
- [Sqlsugar](https://www.donet5.com/)
118+
119+
- [vue-next-admin](https://gitee.com/lyt-top/vue-next-admin)
120+
- [element-plus](https://element-plus.gitee.io/zh-CN/)
121+
122+
- [pure-admin-table](https://gitee.com/yiming_chang/pure-admin-table)
123+
124+
- [idgenerator](https://gitee.com/yitter/idgenerator)
125+
126+
- [LazyCaptcha](https://gitee.com/pojianbing/lazy-captcha)
127+
- [OnceMi.AspNetCore.OSS](https://gitee.com/oncemi/oncemi_aspnetcore_oss)
128+
- [vue3-cute-timeline](https://github.com/xiaojieajie/vue3-cute-timeline)
129+
- [vue-danmaku](https://github.com/hellodigua/vue-danmaku)
130+
- [vue-toastification](https://github.com/Maronato/vue-toastification)
131+
- [tocbot](https://github.com/tscanlin/tocbot)
132+
- [typed.js](https://github.com/mattboldt/typed.js)

0 commit comments

Comments
 (0)