mirror of
https://github.com/nagisa77/OpenIsle.git
synced 2026-02-19 21:41:03 +08:00
docs: expand README with deployment and features
This commit is contained in:
40
README.md
40
README.md
@@ -8,16 +8,48 @@
|
||||
|
||||
## 💡 简介
|
||||
|
||||
OpenIsle 是一个使用 Spring Boot 和 Vue 3 构建的全栈开源社区平台,提供用户注册、登录、贴文发布、评论交互等完整功能,可用于项目社区或直接打造自主社区站点。
|
||||
|
||||
## 🚀 部署
|
||||
|
||||
### 后端
|
||||
1. 确保安装 JDK 17 及 Maven
|
||||
2. 信息配置修改 `src/main/resources/application.properties`,或通过环境变量设置数据库等参数
|
||||
3. 执行 `mvn clean package` 生成包,之后使用 `java -jar target/openisle-0.0.1-SNAPSHOT.jar`启动,或在开发时直接使用 `mvn spring-boot:run`
|
||||
|
||||
### 前端
|
||||
1. `cd open-isle-cli`
|
||||
2. 执行 `npm install`
|
||||
3. `npm run serve`可在本地启动开发服务,产品环境使用 `npm run build`生成 `dist/` 文件,配合线上网站方式部署
|
||||
|
||||
## ✨ 项目特点
|
||||
- JWT 认证以及 Google、GitHub、Discord、Twitter 等多种 OAuth 登录
|
||||
- 支持分类、标签的贴文管理以及草稿保存功能
|
||||
- 嵌套评论、指定贴文或评论的点赞/抖弹系统
|
||||
- 定制统计和通知消息,包括日活跃用户等数据
|
||||
- 全局搜索,支持用户和很多内容的搜索以及内容缩略
|
||||
- 集成 OpenAI 提供的 Markdown 格式化功能
|
||||
- 通过环境变量可调整密码强度、登录方式、保护码等多种配置
|
||||
- 支持图片上传,默认使用腾讯云 COS 扩展
|
||||
|
||||
## 🌟 项目优势
|
||||
- 全面开源,便于二次开发和自定义扩展
|
||||
- Spring Boot + Vue 3 成熟技术栈,学习起点低,社区资源丰富
|
||||
- 支持多种登录方式和角色权限,容易展展到不同场景
|
||||
- 模块化设计,代码结构清晰,维护成本低
|
||||
- REST API 可接入任意前端框架,兼容多端平台
|
||||
- 配置简单,通过环境变量快速调整和部署
|
||||
|
||||
## 🏘️ 社区
|
||||
|
||||
## 📄 授权
|
||||
欢迎彼此交流和使用 OpenIsle,项目以开源方式提供,想了解更多可访问:<https://github.com/nagisa77/OpenIsle>
|
||||
|
||||
## 📋 授权
|
||||
|
||||
本项目以 MIT License 发布,欢迎自由使用与修改。
|
||||
|
||||
## 🙏 鸣谢
|
||||
|
||||
## 🙏 鼓赞
|
||||
- [Spring Boot](https://spring.io/projects/spring-boot)
|
||||
- [JJWT](https://github.com/jwtk/jjwt)
|
||||
- [Lombok](https://github.com/projectlombok/lombok)
|
||||
- 以及所有开源贡献者
|
||||
|
||||
|
||||
Reference in New Issue
Block a user