YoungJeff

简介

一个简单的个人博客网站，使用 Next.js + React 18 + TypeScript + Shadcn/ui + Tailwind CSS 开发

预览

• PC端预览：

  • 前台：http://youngjeff.cn
  • 后台管理：http://youngjeff.cn/admin

• 移动端扫描👇下面二维码访问：

特性

• 使用 Next.js v14 + React 18 hooks 进行构建，完美支持 SSR

• 使用 TypeScript 编写，提供类型安全性和更好的开发体验

• 使用 Prisma 简化数据库 CRUD 操作

• 使用 Redis + ioredis 统计pv/uv

• 使用 Tailwind CSS + shadcn/ui 编写样式和组件

• shadcn/form + react-hook-form + zod 作表单验证

• 使用 iconify 支持各种 svg 图标

• 使用 Bytemd 实现 Markdown 的编写和预览

• 使用 next-theme 支持明暗主题切换

• 使用 next-sitemap 生成全站 sitemap ，SEO 友好

• 使用最新的 next-auth v5和siwe支持 github + 以太坊钱包登录后台

• 使用 ahooks 提升开发效率

• 图片上传后使用 sharp 压缩图片成 webp 格式，减小图片体积

• 图片上传到阿里云 OSS，加快访问图片访问速度

• 响应式设计，对部分屏幕尺寸和设备进行适配

• 集成后台管理功能，如博客、标签管理等

快速开始

环境准备

确保你已安装

• Git
• Pnpm
• Node.js >= 20
• Docker、Docker Compose

获取项目代码

git clone https://github.com/Young-Jeff/blog2.0.git

安装依赖

在项目根目录下运行以下命令安装项目依赖：

pnpm install

准备数据库

开发环境，推荐使用 Docker Compose 启动一个 MySQL，项目已经准备好了一个 docker-compose.yaml 文件

Mac 或者 Linux

项目已经准备好了一个 Makefile 文件

在项目根目录下运行

# Docker Compose 只启动 MySQL
make run_mysql8

# Docker Compose 启动全部服务
make run_all

Windows

在项目根目录下运行

# Docker Compose 只启动 MySQL
docker-compose up -d mysql8

# Docker Compose 启动全部服务
docker-compose up -d

更多

更多信息可查看项目内的 docker-compose.yaml 和 Makefile 文件

准备 env 文件和配置

配置 .env 文件

.env 文件主要是给 Prisma 用的，Prisma 读取 DATABASE_URL 进行数据库连接

新建一个 .env 文件，在 .env 文件新增以下内容

# DATABASE_URL 格式为 mysql://用户名:用户密码@数据库IP:数据库端口/需要连接的数据库名
# 根据实际情况进行修改
DATABASE_URL="mysql://root:[email protected]:3306/blog2.0"

# 根据实际情况进行修改
REDIS_HOST="127.0.0.1"
REDIS_PORT="6379"

配置 .env.development 文件

.env.development 文件是开发环境的配置文件，Next.js 在开发模式会自动加载 .env.development 的内容

复制一份 .env.example，重命名为 .env.development，根据自己实际情况修改以下字段

Github 登录用，如果不用 Github 登录，可不配置

• AUTH_GITHUB_ID：Github 授权应用 ID
• AUTH_GITHUB_SECRET：Github 授权应用 secret

Google 登录用，如果不用 Google 登录，可不配置

• AUTH_GOOGLE_ID：Google 授权应用 ID
• AUTH_GOOGLE_SECRET：Google 授权应用 secret

必须配置

• NEXT_PUBLIC_ADMIN_EMAILS：ADMIN 邮箱列表，只有配置在这里的邮箱，才允许在后台管理进行新增、修改、删除操作

启动开发服务器

1. 创建表

pnpm db:push

2. 生成 Prisma 类型文件

pnpm db:gen

做了这一步后，重启一下 VS Code（Ctrl/Cmd + Shipt + P，然后选 Reload Window），重新加载TypeScript类型文件

3. 启动开发服务器

pnpm dev

4. 预览

• 访问前台: http://localhost:6121
• 访问后台管理: http://localhost:6121/admin

5. 查看数据库

这里推荐使用 Prisma Studio 查看数据，你也可以使用数据库连接软件连接我们的数据库查看数据

新开一个终端，在项目根目录下运行

pnpm db:studio

启动完后会自动打开浏览器，可以在线查看数据库内的数据

自定义页面的信息

你可能想修改页面中的信息，请修改 constants/info.ts 文件