Skip to content

Latest commit

 

History

History
198 lines (146 loc) · 5.67 KB

README.md

File metadata and controls

198 lines (146 loc) · 5.67 KB

iBlog

基于 Node.js 的开源个人博客系统,现代化的 UI 和用户体验。支持桌面端和移动端访问,支持深色模式,支持 Docker 部署。
不仅仅是博客,更是 Demo,是适合新人入门学习的完整项目。

目录

界面预览

  • 博客首页 首页
  • 后台管理 后台
  • 移动端 移动端

在线实例

我的博客 https://skysun.name/

分支说明

技术构成

快速开始

准备条件

安装 Node.js (v8 以上版本)、MongoDB
推荐安装 Yarn 而非 npm 以进行包管理。

安装依赖

$ yarn

启动站点

  • 开发模式
$ yarn run dev
  • 生产模式

先编译项目

$ yarn run build

再启动站点

$ yarn start

打开浏览器,访问 http://localhost:9000/

Debug

  • 要启动前端代码调试,请直接在 Chrome Dev Tools - Sources 面板中进行。

  • 要启动服务端代码调试,请以如下命令启动服务,然后点击 Chrome Dev Tools 左上角的 Node.js 按钮,就可以像调试前端代码一样调试服务端了。

$ node --inspect node_modules/.bin/nuxt-ts

Enjoy it! 😄

系统设置

根据实际情况修改 /blog.config.ts 配置文件,修改后需要重启服务器才能生效。
参数说明:

host

String 类型,主机名,配置为 0.0.0.0 表示监听任意主机。

port

Number 类型,端口号。

enableHTTPS

Boolean 类型,是否启用 HTTPS。

mongoUrl

String 类型,MongoDB 链接。

jwtSecret

String 类型,JWT 秘钥。

线上部署

使用PM2

推荐使用 pm2 进行 Node.js 的进程管理和持久运行。

安装

$ yarn global add pm2

启动

$ pm2 start pm2.json

使用noginx

noginx 是基于 Node.js 的 HTTP 及反向代理服务器(类似 nginx),如果你有多台 iBlog 服务器实例,你可以使用 noginx 进行代理转发和负载均衡。

Docker

iBlog 支持使用 Docker 容器快速部署并启动项目。

安装Docker

官方下载页面 选择对应平台的 Docker Desktop 下载并安装。

制作镜像

在项目根目录下执行如下命令创建镜像文件:

$ yarn run dockerImage

如果创建成功,你可以使用如下命令查看到生成的镜像:

$ docker image ls

创建容器

执行如下命令创建容器:

$ yarn run dockerRun

容器管理

通过 Docker Desktop 执行启动、停止、查看日志等操作。 Docker Desktop

更新日志

请直接查看 Commit 记录。

项目的后续更新计划,欢迎提交 PR

许可协议

MIT License

Copyright (c) 2020 Sky.Sun 孙正华

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.