lowcode-cms开源社区源码设计分享

简介: lowcode-cms开源社区源码设计分享

image.png

开源背景

lowcode可视化社区 是我之前在设计研发 Dooring低代码 平台时开发的一个面向低代码内容分享的知识社区, 内容端采用 SSR 技术来渲染页面, 对 SEO 更加友好, 同时后端服务采用 Nodejs 来实现, 内容端和服务端同端, 也就是传说中的内容服务“同构”. 管理端采用前端最最流行的 React hooks 来实现, 无论是技术人员还是非技术人员, 通过简单的操作就可以轻松部署一套专属自己的 CMS 系统.

本着满满的开源精神, 我对这套 CMS 系统进行了开源, 让更多技术小白或者非技术人员, 可以轻松部署自己的网站.

接下来我会从技术的角度, 分享一下我开源的 lowcode-cms 系统的技术实现, 以及如何本地运行 + 部署这套开箱即用的 CMS 系统.

系统设计架构

image.png

接下来我会具体和大家介绍一下管理端, 内容端, 服务端的技术架构.

内容端架构设计

内容端主要用来展现个人或者企业的内容信息, 相当于一个门户站, 这里为了更好的 SEO, 我采用了模版引擎来渲染 html, 也就是koa-views + pug 模式, 具体界面如下:

image.png

当然这只是首页模块, 还有诸如行业产品, 最佳实践, 视频, 手记等, 这里就不一一介绍了, 大家如果会编程的话, 也可以自定义自己的模块页面. 我们接下来看看具体的技术实现.

image.png

大家可以在github中server的views目录下看到每个渲染层的具体实现, 这里和大家分享一下 lowcode-cms 搭建的ssr模式.

1. 配置pug支持

import koa from "koa";
import views from "koa-views";
// ... (此处省略服务端自治的部分代码)
// 挂载路由
glob.sync(`${config.routerPath}/*.js`).forEach((item) => {
  require(item).default(router, config.API_VERSION_PATH);
});
//使用模版引擎
app.use(views(resolve(__dirname, "./views"), { extension: "pug" }));
app.use(router.routes()).use(router.allowedMethods());

2. ssr路由数据直出

这块主要是基于用户发起的请求, 在服务端格式化好数据供 pug 消费:

/**
 * 文章路由
 * @param {*} router
 * @param {*} apiPath
 */
const pageRenderRouter = (router) => {
  // api路径
  const api = {
    // 渲染首页
    index: "/",
    // 最佳实践列表
    bestPractice: "/best-practice",
    product: "/product",
    video: "/video",
    note: "/note",
    login: "/login",
    // 其他渲染路由...
  };
  // 内容端导航配置
  const nav = [
    {
      id: "0",
      title: "最佳实践",
      link: "/best-practice"
    },
    {
      id: "1",
      title: "行业产品",
      link: "/product"
    },
    {
      id: "3",
      title: "视频",
      link: "/video"
    },
    {
      id: "4",
      title: "手记",
      link: "/note"
    },
    {
      id: "5",
      title: "关于",
      link: "/about"
    },
  ]
  const copyright = "版权所有 @lowcode可视化社区"
  // 登录
  router.get(api.login, async (ctx) => {
    await ctx.render("login", {
      url: api.login,
      title: "登录",
      description: "新用户?",
      href: "去注册",
      firstInput: "邮箱",
      twoInput: "密码",
      btnText: "登录",
      logoText: "Dooring低代码社区",
    });
  });
  // 渲染首页
  router.get(api.index, async (ctx) => {
    const filePath = `${config.publicPath}/db/homeConfig.json`;
    const articlesPath = `${config.publicPath}/db/article_index.json`;
    const productsPath = `${config.publicPath}/db/product_index.json`;
    const videosPath = `${config.publicPath}/db/video_index.json`;
    const homeConfig = RF(filePath);
    const articles = RF(articlesPath);
    const products = RF(productsPath);
    const videos = RF(videosPath);
    await ctx.render("index", {
      nav,
      articles: articles.filter(v => v.review === 1).slice(0, 6),
      products: products.filter(v => v.review === 1).slice(0, 6),
      videos: videos.filter(v => v.review === 1).slice(0, 6),
      copyright,
      ...homeConfig
    });
    // 统计访问量
    const viewPath = `${config.publicPath}/db/views.json`;
    const views = RF(viewPath);
    WF(viewPath, {...views, home: views.home + 1});
  });
  // 渲染文章详情页
  router.get(api.articleDetail, async (ctx) => {
    const id = ctx.query.fid;
    const articlePath = `${config.publicPath}/db/articles/${id}.json`;
    const commentPath = `${config.publicPath}/db/comments/${id}.json`;
    const article = RF(articlePath) || {};
    const comments = RF(commentPath) || {};
    comments.views = comments.views + 1;
    await ctx.render("article_detail", {
      nav,
      viewTitle: article.title,
      topImg: article.img,
      authorInfo: { name: article.author, date: formatTime(article.ct, "-") },
      cate: article.cate,
      val:  article.type ? marked(article.val) : article.val,
      commentInfoList: comments.comments || [],
      flover: comments.flover,
      views: comments.views || 0,
      copyright,
    });
    WF(commentPath, comments);
  });
  // 其他页面渲染服务逻辑...
  });
};
export default pageRenderRouter;

3. 模版消费

这里给大家参考一个我写的 pug 页面的例子:

image.png

大家感兴趣的可以参考一下具体的实现:

github.com/MrXujiang/l…

服务端架构设计

image.png

服务端本质上主要实现两块能力:

  • 内容端页面渲染(SSR)
  • 后台API和三方接口服务对接

服务端我参考了通用后端服务的 MVC 模式, 基于 koa2 搭建了一个简易的服务端 MVC 模型, 如下是一个服务端的代码目录:

image.png

主要实现的核心模块有:

  • 静态资源服务器
  • 微信分享, CDN上传等第三方服务模块
  • api路由
  • 中间件模块
  • 资源上传模块
  • 用户权限模块
  • ssr服务模块

如果搭建感兴趣可以参考 github 中具体的实现代码:

github.com/MrXujiang/l…

管理端系统架构设计

image.png

管理端采用的是 umi + react + antd4.0 实现的, 当然封装了很多成熟的插件模块, 比如说 富文本编辑器, md编辑器, 文件上传模块等, 大家可以在学习源码的过程中受益非浅.

image.png

上图就是编辑模块, 我封装了实时预览 md富文本的模块, 大家可以拿来即用.

本地运行

1. 目录介绍
  • server 基于nodejs的服务端, 启动后可直接访问3000 端口, 也就是内容SSR端
  • admin CMS的管理后台, 集成了用户管理, 内容审核, 内容发布, 数据统计等模块

开箱即用~~

2. 本地启动
  1. server端
# 进入server目录
cd server
# 安装依赖
yarn
# 服务端启动
yarn start

注: 如果是window系统, 可以执行 yarn start:win

  1. 管理端
# 进入admin目录
cd admin
# 安装依赖
yarn
# 启动
yarn start

初始化账号: super_123, 密码: zxzk_123

  1. 内容端

访问3000端口即可.

部署发布

推荐使用 pm2 来管理 Node 服务进程, 只需要把 server 端上传到服务器, 安装对应依赖, 用 pm2 启动即可:

pm2 start server/dist

有关 pm2 相关问题可以在我往期的文章中学习参考.

如何参与贡献和问题反馈

如果大家有好的建议或者想法, 可以在 github 上提 pr 或者 issue 来共建, 或者在《趣谈前端》公众号中和我反馈.

github: github.com/MrXujiang/l…

目录
相关文章
|
5月前
|
IDE 前端开发 数据库
OpenSumi开源问题之OpenSumi的定义如何解决
OpenSumi开源问题之OpenSumi的定义如何解决
|
8月前
|
前端开发 JavaScript
开源! 基于lowcode行业的开源CMS系统,轻松帮助企业和个人搭建知识管理系统
开源! 基于lowcode行业的开源CMS系统,轻松帮助企业和个人搭建知识管理系统
90 2
|
Kubernetes Cloud Native Dubbo
Higress 开源后,我们整理了开发者最关心的 15 个问题
云原生网关 Higress 开源后,引起了开发者们的热烈讨论,我们整理了大家在 GitHub、钉群、微信群讨论的问题,并将回答汇总如下,方便各位更准确的读懂 Higress,也非常欢迎您和我们一起共建、定义 Higress。
357 13
Higress 开源后,我们整理了开发者最关心的 15 个问题
|
设计模式 架构师 Java
程序员必修课:阿里性能优化全解终开源!设计+代码+JVM三飞
性能优化可以说是我们程序员的必修课,如果你想要跳出CRUD的苦海,成为一个更“高级”的程序员的话,性能优化这一关你是无论无何都要去面对的。为了提升系统性能,开发人员可以从系统的各个角度和层次对系统进行优化。除了最常见的代码优化外,在软件架构上、JVM虚拟机层、数据库以及操作系统层面都可以通过各种手段进行调优,从而在整体上提升系统的性能。
|
设计模式 缓存 Java
好家伙!阿里新产Java性能优化(终极版),涵盖性能优化所有操作
上月公司来了一位大佬,入职不到一周就把公司现有项目的性能优化了一遍,直接给公司节省了一半的成本。 一问情况,才知道这位仁兄也是一路被虐过来的。去年年底被裁,本以为自己技术还行,看了一段时间面经,复习了基础知识,就开始投大厂简历。阿里最先给他面试机会,结果没能扛过三面,然后是各种大大小小的公司,在实际面试中被碾压得翻不了身。整整一个半月,一个offer都没拿到,最后针对性的恶补,才入职了我司。
|
架构师 前端开发 JavaScript
EggJS 渐进式开发
EggJS 渐进式开发
179 0
|
存储 缓存 自然语言处理
【字节跳动青训营 】高性能 Go 语言发行版优化与落地实践
1.自动内存管理概要 Auto memory management: 自动内存管理 Grabage collction: 垃圾回收 Mutator: 业务线程 Collector: GC 线程 Concurrent GC: 并发 GC Parallel GC: 并行 GC Tracing garbage collection: 追踪垃圾回收 Copying GC: 复制对象 GC Mark-sweep GC: 标记-清理 GC Mark-compact GC: 标记-压缩 GC Reference counting: 引用计数 Generational GC: 分代 GC Young gene
232 1
【字节跳动青训营 】高性能 Go 语言发行版优化与落地实践
|
Kubernetes Cloud Native 安全
Higress 开源后,我们整理了开发者最关心的15个问题
云原生架构下,网关承载着流量管理、服务调用、安全管理等多重职能,在稳定性、性能、安全性、易用性上存在着更高的要求。在 CNCF Landscpae 编排和管理的 API Gateway 领域中,已经有不少开源的网关选择,开发者们也有着不小的选型诉求。
Higress 开源后,我们整理了开发者最关心的15个问题
|
JavaScript 数据可视化 IDE
QCAD v3.23.0.3源码分析(一)准备工作,去商业插件
QCAD v3.23.0.3源码分析(一)准备工作,去商业插件
591 0
|
前端开发 JavaScript 算法
两年磨一剑,Ant Design核心作者解答开发者关心问题
近日,Ant Design 发布了 4.0 版本,带来了一些重大更新。前端之巅采访了 Ant Design 团队的核心作者之一的蒋吉麟,聊了聊 4.0 版本更新背后的一些故事。
579 0
两年磨一剑,Ant Design核心作者解答开发者关心问题