Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fantasticit/wipi
A blog system written by next.js, nest.js and MySQL.
https://github.com/fantasticit/wipi
nestjs nextjs nysql react sass
Last synced: about 2 months ago
JSON representation
A blog system written by next.js, nest.js and MySQL.
- Host: GitHub
- URL: https://github.com/fantasticit/wipi
- Owner: fantasticit
- License: apache-2.0
- Created: 2018-01-06T12:00:41.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-07-03T14:54:00.000Z (3 months ago)
- Last Synced: 2024-07-15T12:53:12.841Z (2 months ago)
- Topics: nestjs, nextjs, nysql, react, sass
- Language: TypeScript
- Homepage: https://blog.codingit.cn/
- Size: 12.6 MB
- Stars: 615
- Watchers: 9
- Forks: 121
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Wipi
## 简介
Wipi 是一个面向个人的开源的集成文章发表、页面创建、知识小册等功能的 CMS 系统。涉及到的技术如下：
- `MySQL`：数据存储
- `next.js`：前端页面框架
- `nest.js`：服务端框架
- `AliyunOSS`：对象存储
## 链接
- [Github 源码](https://github.com/fantasticit/wipi)
- [前台页面](https://blog.codingit.cn/)
- [管理系统](https://admin.blog.codingit.cn/)：支持访客注册
## 功能点
- 文章管理
- 页面管理
- 知识小册
- 评论管理
- 邮件管理
- 访问统计
- 文件管理
- 系统设置
更多功能，欢迎访问系统进行体验。
## 预览
## 项目运行
### 数据库
首先安装 `MySQL`，推荐使用 docker 进行安装。
```bash
docker image pull mysql:5.7
docker run -d --restart=always --name wipi -p 3306:3306 -e MYSQL_ROOT_PASSWORD=root mysql:5.7
```
然后在 `MySQL` 中创建数据库。
```bash
docker container exec -it wipi bash;
mysql -u root -p;
CREATE DATABASE `wipi` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
```
### 本地运行
首先，clone 项目。
```bash
git clone --depth=1 https://github.com/fantasticit/wipi.git your-project-name
```
然后，安装项目依赖。
```bash
# 全局安装 pnpm
npm i -g pnpm
pnpm install
```
- 启动项目
```bash
pnpm run dev
```
前台页面地址：`http://localhost:3001`。
后台管理地址：`http://localhost:3002`。
服务接口地址：`http://localhost:3003`。
首次启动，默认创建管理员用户：admin，密码：admin（可在 `.env` 文件中进行修改）。
[PS] 如服务端配置启动失败，请先确认 MySQL 的配置是否正确，配置文件在 `.env`。
### 系统设置
项目初次启动时，需要在后台进行系统设置。随着内容的丰富，页面内容也会丰富起来。
### 配置文件
默认加载 `.env` 文件，生产环境会尝试加载 `.env.prod` 文件。
```bash
# 客户端运行端口
CLIENT_PORT=3001
# 客户端站点地址（假设部署到 https://xx.com, 就将 CLIENT_SITE_URL 设置为 https://xx.com）
CLIENT_SITE_URL=http://localhost:3001
# 客户端资源地址（假设部署到 https://xx.com，就将 CLIENT_ASSET_PREFIX 设置为 https://xx.com，如果将资源上传到 cdn ，那就改为 cdn 地址）
CLIENT_ASSET_PREFIX=/
# 管理后台运行端口
ADMIN_PORT=3002
# 管理后台资源地址（假设部署到 https://xx.com，就将 CLIENT_ASSET_PREFIX 设置为 https://xx.com，如果将资源上传到 cdn ，那就改为 cdn 地址）
ADMIN_ASSET_PREFIX=/
# 服务端运行端口
SERVER_PORT=3003
# 服务端完整访问路径
SERVER_API_URL=http://localhost:3003/api
# 服务端接口前缀（假设将希望通过 http://xx:com/api 来访问，那就设置为 /api；如果 http://xx:com，那就设置为 / ）
SERVER_API_PREFIX=/api
# 默认管理员账户名
ADMIN_USER=admin
# 默认管理员账密码
ADMIN_PASSWD=admin
# 以下为数据库配置，请先创建好表
DB_HOST=127.0.0.1
DB_PORT=3306
DB_USER=root
DB_PASSWD=root
DB_DATABASE=wipi
# Github 第三方登录配置
# 关于 Github OAuth 可参考 https://www.ruanyifeng.com/blog/2019/04/github-oauth.html
GITHUB_CLIENT_ID=0 # Github OAuth 登录 Id
GITHUB_CLIENT_SECRET=0 # Github OAuth 登录 Secret
```
### 项目部署
生产环境部署的脚本如下：
```bash
node -v
npm -v
npm config set registry http://registry.npmjs.org
npm i -g pm2 @nestjs/cli pnpm
pnpm install
pnpm run build
pnpm run pm2
pm2 startup
pm2 save
```
### nginx 配置
采用反向代理进行 `nginx` 配置，**同时设置 `proxy_set_header X-Real-IP $remote_addr;` 以便服务端获取到真实 ip 地址**。
```bash
upstream wipi_client {
server 127.0.0.1:3000;
keepalive 64;
}
# http -> https 重定向
server {
listen 80;
server_name 域名;
rewrite ^(.*)$ https://$host$1 permanent;
}
server {
listen 443 ssl;
server_name 域名;
ssl_certificate 证书存放路径;
ssl_certificate_key 证书存放路径;
location / {
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $host;
proxy_set_header X-Nginx-Proxy true;
proxy_cache_bypass $http_upgrade;
proxy_pass http://wipi_client; #反向代理
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}
}
```
## 资料
- next.js 源码：https://github.com/vercel/next.js
- next.js 文档：https://nextjs.org/
- nest.js 源码：https://github.com/nestjs/nest
- nest.js 文档：https://nestjs.com/