快速开始
后端
版本说明
README
大多数小伙伴刚开始接触时,遇到的第一个问题是:后端不支持 Java 8 吗?在此,先说明下目前项目的分支及版本支持情况。
目前,ContiNew Admin 最新版本的后端采用 Spring Boot 3.1.x(Java 17),而 Java 8 则是在 1.3.x 分支进行维护,不过,只进行问题修复及小幅优化,不再进行新功能扩展。
分支 | 仓库地址 | Java版本 |
---|---|---|
dev | Gitee:https://gitee.com/continew/continew-admin GitHub:https://github.com/charles7c/continew-admin | Java 17 |
1.3.x | Gitee:https://gitee.com/continew/continew-admin/tree/1.3.x/ GitHub:https://github.com/charles7c/continew-admin/tree/1.3.x/ | Java 8 |
友情链接
- Spring Boot 3.0 于 2022年11月24日 发布,要求从 3.0 开始使用 Java 17 作为最低版本。详情请点击查看 Spring Boot 3.0 发行说明。
- Spring Boot 已于 2023年11月24日 结束了 2.7.x 及 3.0.x 版本的社区支持。详情请点击查看 最新支持情况。
- Java 8 于 2014年3月18日 发布,这个版本是自 Java 5(发布于2004年)之后的一个重量级版本,也是 Java 发展史上的一个里程碑式的版本,它带来了诸多改进,包括 Lambda 表达式、Streams、日期时间 API 等等。
- Java 17 于 2021年9月14日 发布,它是一个长期支持版本(Long-Term-Support - LTS)。从 Java 8 过渡到 Java 17 将带来许多新特性和安全、性能方面的改进。详情请点击查看 Oracle JDK 17 文档。
- 根据 JetBrains 2023 开发者生态系统现状调查报告,经常使用的 Java 版本:Java 8(50%)、Java 17(45%)、Java 11(38%)。详情请点击查看 2023 开发者生态系统现状调查报告。
- 您访问本文档的时间:2024/5/12 12:10:52
环境说明
README
下方为本项目后端所需运行环境,请注意检查您的环境是否与本项目所需一致,以减少环境引起的问题。
运行环境 | 演示环境版本 | 最低版本 | 安装教程 |
---|---|---|---|
JDK | OpenJDK 17.0.2 | 17(dev分支) 8(1.3.x分支) | 《Java 开发环境搭建》 |
Maven | 3.6.3 | 3.6.x+ | - |
MySQL | 8.0.33 | 5.7.x+ | - |
Redis | 7.2.3 | - |
克隆项目
使用下方 Git 命令,将项目克隆到本地开发机器。也可以先在 Github 或 Gitee 上将项目 fork 到自己的仓库,然后将 fork 过来的项目克隆到本地。
git clone https://gitee.com/continew/continew-admin.git
git clone https://github.com/charles7c/continew-admin.git
当然了,你可以通过任何一种你喜欢的方式将项目下载到本地(正式开发时,请下载最新稳定版,详情见《项目开发》篇),包括且不限于下载压缩包、在 IDE 中直接导入等,全看个人习惯。
在 IDE 中打开
在 IDE 中打开项目,本指南均以 IntelliJ IDEA 为例,其他 IDE 可根据需要自行查找类似使用方式。
点击信任项目。
修改配置
将 application-dev.yml
配置文件中的数据源配置信息(请提前创建好对应数据库,例如:continew_admin)、Redis 配置信息修改为自己实际的环境信息。
不过,相比于在配置文件中修改值,还有一种更为方便的方式调整配置。在配置文件中,你会看到很多类似于 ${DB_HOST:127.0.0.1}
的配置值,它表示如果存在 DB_HOST
环境变量,则使用环境变量 DB_HOST
的值,如果没有则使用默认值 127.0.0.1
。
在 IntelliJ IDEA 等 IDE 中,可以直接配置启动程序的环境变量。
进入下图配置界面后,直接按下 Alt + E
,可以直接弹出【环境变量】配置输入框,当然也可以如下图所示依次点选。
点击【环境变量】输入框右侧的【编辑】按钮,可以一条条的去添加环境变量。本项目需要配置的环境变量有:DB_HOST、DB_PORT、DB_USER、DB_PWD、DB_NAME;REDIS_HOST、REDIS_PORT、REDIS_PWD、REDIS_DB。
温馨提示
一条条添加环境变量实在过于麻烦,不知道你有没有注意到环境变量配置下方有个提示:用分号分隔变量:VAR=value;VAR1=value1
。所以,你可以复制下方的这串环境变量,将配置更改后直接粘贴过去即可。
DB_HOST=你的配置;DB_NAME=你的配置;DB_PORT=你的配置;DB_PWD=你的配置;DB_USER=你的配置;REDIS_DB=你的配置;REDIS_HOST=你的配置;REDIS_PORT=你的配置;REDIS_PWD=你的配置
启动程序
配置修改完毕后,直接启动程序即可。是的,没看错,无需单独执行表结构和初始数据脚本(务必提前创建好对应数据库),直接以调试方式或正常启动程序即可,项目启动后,Liquibase 组件会自动执行 continew-admin-webapi/src/main/resources/db/changelog
目录下的初始化 SQL 脚本。
等到控制台输出下方这段内容,表示后端项目启动成功。
也可以点击打开 API 地址的链接,浏览器将会输出如下内容。
ContiNew Admin service started successfully.
前端
环境说明
README
下方为本项目前端所需运行环境,请注意检查您的环境是否与本项目所需一致,以减少环境引起的问题。
运行环境 | 演示环境版本 | 最低版本 | 安装教程 |
---|---|---|---|
Node | 18.16.0 | 18+ | - |
PNPM | 8.15.5 | 8+ | - |
本项目前端使用 pnpm(Performant NPM)作为包管理工具。
# 安装 pnpm
npm install -g pnpm
# 查看版本
pnpm -v
克隆项目
使用下方 Git 命令,将项目克隆到本地开发机器。也可以先在 Github 或 Gitee 上将项目 fork 到自己的仓库,然后将 fork 过来的项目克隆到本地。
git clone https://gitee.com/continew/continew-admin-ui.git
git clone https://github.com/charles7c/continew-admin-ui.git
当然了,你可以通过任何一种你喜欢的方式将项目下载到本地(正式开发时,请下载最新稳定版,详情见《项目开发》篇),包括且不限于下载压缩包、在 IDE 中直接导入等,全看个人习惯。
温馨提示
如果是 ContiNew Admin v2.3.0 之前的版本,前端项目 continew-admin-ui
和后端项目均处于同一个仓库,所以当下载了后端项目之后,对应的前端项目也已经包含在内了。
在 IDE 中打开
在 Visual Studio Code 或 WebStorm 等 IDE 中打开前端项目 continew-admin-ui
,本指南均以 WebStorm 为例,其他 IDE 可根据需要自行查找类似使用方式。
打开终端,输入如下命令,安装依赖。
pnpm install
启动程序
等待依赖安装完毕后,打开 package.json
,运行 dev 脚本,或者直接在终端运行如下命令。
pnpm dev
前端项目启动成功,默认浏览器会弹出标签页打开登录页面,如果后端项目也已经正常启动,登录页面会出现图形验证码。输入账密及验证码,点击登录,开始体验。(如在使用中遇到问题欢迎在交流群内或 issues 中进行反馈)
超级管理员
用户名:admin
密码:admin123
友情提示
项目每增长一颗 star,可以给维护者们注入莫大的激情,诚恳的希望您能动动发财的小手,为 ContiNew Admin 点亮一颗小星星。
如果你只想在本地启动前端,又苦于没有后端服务。别急,大佬 莫愁
免费提供了 ContiNew Admin 后端 API 服务,可进群 @莫愁
大佬白嫖,白嫖成功后把 .env.development
文件内的接口前缀配置删除,接口地址配置更改成对应 API 服务地址即可。
# 环境变量 (命名必须以 VITE_ 开头)
# 接口前缀
VITE_API_PREFIX = '/api'
# 接口地址
VITE_API_BASE_URL = 'http://localhost:8000'
# 地址前缀
VITE_BASE = '/'
# 是否开启开发者工具
VITE_OPEN_DEVTOOLS = true