SimpleMindMap

中文

English

中文

English

暗黑模式

部署 ​

本项目的web目录下提供了一个基于simple-mind-map库、Vue2.x、ElementUI开发的完整项目，数据默认存储在电脑本地，此外可以操作电脑本地文件，原意是作为一个线上demo，但是也完全可以直接把它当做一个在线版思维导图应用使用，在线地址：https://wanglin2.github.io/mind-map/。

如果你的网络环境访问GitHub服务很慢，你也可以部署到你的服务器上。

部署到静态文件服务器 ​

项目本身不依赖后端，所以完全可以部署到一个静态文件服务器上，可以依次执行如下命令：

bash
git clone https://github.com/wanglin2/mind-map.git
cd mind-map
cd simple-mind-map
npm i
npm link
cd ..
cd web
npm i
npm link simple-mind-map

然后你可以选择启动本地服务：

bash
npm run serve

也可以直接打包生成构建产物：

bash
npm run build

打包完后的入口页面index.html可以在项目根目录找到，对应的静态资源在根目录下的dist目录，html文件中会通过相对路径访问dist目录的资源，比如dist/xxx。你可以直接把这两个文件或目录上传到你的静态文件服务器，事实上，本项目就是这样部署到GitHub Pages上的。

如果你没有代码修改需求的话，直接从本仓库复制这些文件也是可以的。

如果你想把index.html也打包进dist目录，可以修改web/package.json文件的scripts.build命令，把vue-cli-service build && node ../copy.js中的 && node ../copy.js删除即可。

如果你想修改打包输出的目录，可以修改web/vue.config.js文件的outputDir配置，改成你想要输出的路径即可。

如果你想修改index.html文件引用静态资源的路径的话可以修改web/vue.config.js文件的publicPath配置。以及web/public/index.html文件的window.externalPublicPath配置。

另外默认使用的是hash路由，也就是路径中会在#，如果你想使用history路由，可以修改web/src/router.js文件，将：

js
const router = new VueRouter({
  routes
})

改成：

js
const router = new VueRouter({
  mode: 'history',
  routes
})

不过这需要后台支持，因为我们的应用是个单页客户端应用，如果后台没有正确的配置，当用户在浏览器直接访问子路由时会返回404，所以呢你要在服务端增加一个覆盖所有情况的候选资源：如果URL匹配不到任何静态资源，则应该返回同一个index.html页面。

Docker ​

镜像1 ​

非常感谢Hraulein维护的Docker镜像。

支持架构: amd64 arm64 arm/v7 arm/v8

安装 ​

docker cli

bash
docker run -d --name mind-map -p 8080:8080 --restart always -e GIN_MODE=release hraulein/mind-map:latest

docker compose

bash
services:
  mind-map:
    image: hraulein/mind-map:latest
    container_name: mind-map
    restart: always
    ports:
      - "8080:8080"
    environment:
      - GIN_MODE=release # debug 为调试模式

使用 ​

在浏览器中输入以下地址即可使用 Web 版思维导图: http://$IP_ADDRESS:$PORT

参数:

  • $IP_ADDRESS

    • 本机访问: 使用 127.0.0.1 或 localhost
    • 局域网访问: 输入部署主机的内网 IP（如 172.16.19.156）
    • 公网访问（如有）: 输入服务器公网 IP 或域名

  • $PORT

    • 默认使用 8080 端口，若启动时修改了端口映射（如 -p 8888:8080），此处需对应改为映射的主机端口（即 8888）

示例:

本机访问: http://127.0.0.1:8080
局域网访问: http://172.16.19.156:8080
自定义端口: http://172.16.19.156:8888

nginx 反向代理配置 (可选) ​

需要有域名/HTTPS证书

# HTTP 重定向 HTTPS
server {
    listen 80 default_server;
    listen [::]:80 default_server;
    return 301 https://$host$request_uri;
}

server {
	
    listen 443 ssl;
    listen [::]:443 ssl;
    http2 on;    
  
    server_name mind-map.hraulein.localhost;   # <<< 替换为你的域名
    set $IPADDR 172.16.19.156;                 # <<< 替换为你服务器的内网 IP 地址

    ssl_certificate '/etc/nginx/*****/*****/fullchain.cer';    # <<< 替换为实际的证书地址
    ssl_certificate_key '/etc/nginx/*****/*****/*****.key';    # <<< 替换为实际的证书地址
    ssl_trusted_certificate '/etc/nginx/*****/*****/ca.cer';   # <<< 替换为实际的证书地址
    ssl_session_cache shared:SSL:1m;
    ssl_session_timeout 10m;
    ssl_session_tickets off;
    ssl_prefer_server_ciphers on;
    ssl_ciphers 'ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256';
    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_stapling on;
    ssl_stapling_verify on;
    resolver 8.8.8.8 1.1.1.1 valid=300s;
    resolver_timeout 5s;
    add_header Strict-Transport-Security "max-age=31536000" always;

    location / {
        proxy_pass http://$IPADDR:8080;        # <<< 替换为 mind-map 服务实际映射端口
        proxy_set_header Host $host;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection upgrade;
        proxy_set_header Accept-Encoding gzip;
    }
}

镜像2 ​

非常感谢水车维护的Docker镜像。

直接从 Docker hup 中安装：

docker run -d -p 8081:8080 shuiche/mind-map:latest

mind-map在容器中启动了8080端口作为web服务入口，通过docker运行容器时，需要指定本地映射端口，上面案例中，我们通过本地的8081端口映射到容器端口8080。

安装完成后，通过 docker ps 查看容器运行状态。

浏览器打开 127.0.0.1:8081 即可使用Web 思维导图功能。

在群晖上以 Docker 方式安装

使用宝塔面板Docker的部署说明 ​

本小节文档由bestlaw66编写。

拥有自己的宝塔 ​

当你需要通过 宝塔面板 部署本项目之前，需要在服务器上先安装好 宝塔面板工具。 接下来的 部署流程 都建立在已有宝塔面板的前提下。宝塔安装请参考 (宝塔官网)。

注意：本项目需要宝塔面板版本 9.2.0 及以上

一键安装 ​

install1

  1. 在 宝塔面板 -> Docker -> 应用商店 页面，搜索 Simple 找到本项目的docker应用；

  2. 点击 安装 开始部署本项目；

install2

  1. 在项目配置页，根据要求开始配置环境变量；

  2. 如勾选 允许外部访问 配置，请注意为配置的 web端口 开放安全组端口访问权限；

  3. 点击 确认 开始自动部署；

如何访问 ​

通过根据 服务器IP地址 和配置的 web端口 http://$(host)😒(port)，在浏览器中打开 Simple mind map。

install3

对接自己的存储服务 ​

应用数据默认存储在浏览器本地，浏览器本地存储容量是比较小的，所以当在思维导图中插入更多图片后很容易触发限制，所以更好的选择是对接你自己的存储服务，这通常有两种方式：

第一种 ​

直接clone本仓库代码，然后修改web/src/api/index.js内的相关方法即可实现从你的数据库里获取数据，以及存储到你的数据中。

第二种 ​

很多时候，你可能想始终使用本仓库的最新代码，那么第一种方式就不太方便，因为你要手动去合并代码，所以提供了第二种方式。

具体操作步骤：

1.复制web应用打包后的资源

包括：dist目录和index.html文件。

2.修改复制后的index.html文件

首先在head标签里插入如下代码：

js
<script>
  window.takeOverApp = true
</script>

这行代码会提示应用不要初始化应用即：new Vue()，而是把控制权交给你，接下来再在body的最后插入你自己的js代码，内联或则外链都可以，内联示例如下：

js
<script>
  // 你自己的请求数据的方法
  const getDataFromBackend = () => {
    return new Promise((resolve, reject) => {
      setTimeout(() => {
        resolve({
          // 思维导图数据
          mindMapData: {
            root: {
              "data": {
                  "text": "根节点"
              },
              "children": []
            },
            theme: { "template":"avocado","config":{} },
            layout: "logicalStructure",
            config: {},
            view: {}
          },
          // 页面语言，支持中文（zh）、英文（en）
          lang: 'zh',
          // 页面部分配置
          localConfig: null
        })
      }, 200)
    })
  }
  // 注册全局方法
  const setTakeOverAppMethods = (data) => {
    window.takeOverAppMethods = {}
    // 获取思维导图数据的函数
    window.takeOverAppMethods.getMindMapData = () => {
      return data.mindMapData
    } 
    // 保存思维导图数据的函数
    window.takeOverAppMethods.saveMindMapData = (data) => {
      console.log(data)
      // 该函数触发频率可能会很高，所以你应该做一下节流或防抖
    }
    // 获取语言的函数
    window.takeOverAppMethods.getLanguage = () => {
      return data.lang
    }
    // 保存语言的函数
    window.takeOverAppMethods.saveLanguage = (lang) => {
      console.log(lang)
    }
    // 获取本地配置的函数
    window.takeOverAppMethods.getLocalConfig = () => {
      return data.localConfig
    }
    // 保存本地配置的函数
    window.takeOverAppMethods.saveLocalConfig = (config) => {
      console.log(config)
    }
  }
  window.onload = async () => {
    if (!window.takeOverApp) return
    // 请求数据
    const data = await getDataFromBackend()
    // 设置全局的方法
    setTakeOverAppMethods(data)
    // 思维导图实例创建完成事件
    window.$bus.$on('app_inited', (mindMap) => {
      console.log(mindMap)
    })
    // 可以通过window.$bus.$on()来监听应用的一些事件
    // 实例化页面
    window.initApp()
  }
</script>

如上所示，当你设置了window.takeOverApp = true标志，应用不再主动进行实例化，而是会将实例化的方法暴露出来由你调用，那么你可以先从后端请求思维导图的数据，然后再注册相关的方法，应用内部会在合适的时机进行调用，从而达到回显和保存的目的。

这样做的好处是，每当本仓库代码更新了，你可以简单的复制打包后的文件到你自己的服务器，只要稍微修改一下index.html页面即可达到同步更新且使用自己的存储服务的目的。

修改静态资源路径 ​

如果你想和上一节一样保持和本仓库代码的同步更新，但是又想修改静态资源的存放位置，比如默认的层级关系为：

-dist
--css
--fonts
--img
--js
-logo.ico

-index.html

而你想调整成这样：

-assets
--dist
---css
---fonts
---img
---js
-logo.ico

-index.html

那么你可以将index.html中的window.externalPublicPath配置由默认的./dist/修改为：

js
window.externalPublicPath = './assets/dist/'

同时index.html中内联的.ico、.js、.css资源的路径需要你手动修改。

需要注意的是，dist目录内的目录层级关系最好不要调整，否则可能会出现异常。

如果你想替换其中的一些静态资源，比如你想将主题图片和结构的图片替换成你自己设计的图片，那么可以直接同名覆盖。

MIT License.

Copyright © 2024-present mind-map team