团队服务导航

简介

前后端完整的网址导航服务，本系统定位于研发团队内部使用，提供多种的卡片图标生成方式，能将上传的原型压缩包自动生成可访问的地址，支持私密卡片，发布倒计时等功能。

Github: https://github.com/tuituidan/team-nav

Gitee: https://gitee.com/tuituidan/team-nav

功能说明

网址导航前端展示+搜索功能，首页图。
网址导航后台基本功能：分类和卡片的增删改查，后台-分类管理图后台-卡片列表图后台-卡片编辑图。
分类和卡片支持拖拽调整顺序，不用专门维护排序字段。
支持添加秘密卡片分类，该分类下的卡片需要登录才能看见，不开启登录功能则默认不显示。
暂时不需要的分类支持移除功能，移除后分类列表页面不可见，可从历史分类中还原回来，后台-历史分类图。
卡片图标支持四种方式
- 文本图标，输入少量文字作为图标，并可以为其选择背景色。后台-卡片编辑图
- 根据填写的链接自动获取该链接的获取favicon.ico图标。
- 手动上传图片作为图标。
- 可配置默认常用的一些图标，直接选择（搜索按图标文件名搜索），卡片图标选择图。
三种卡片类型说明
- 普通类型：标题，内容，图标为必填，链接非必填，没有链接只是作为少量信息展示，点击卡片不会跳转页面。
- 原型类型：标题，内容，图标，原型文件为必填，原型文件上传后会自动生成原型展示的链接，点击卡片可跳转到该地址。
- 二维码类型：标题，内容，图标，链接均为必填，鼠标滑到卡片上会显示链接的二维码，可用手机进行扫描，方便进行移动端网址显示，二维码展示图。
原型可通过配置Nginx访问，后台-系统设置图。
发布倒计时功能，在首页对项目发布截止时间进行提醒，在系统设置中进行开启和关闭，同时有多个进行中的发布数据时，会定时切换，切换时间也在系统设置中设置。首页-发布倒计时后台-发布倒计时

设计说明

以SpringDataJpa+H2数据库（文件存储方式）的方式进行数据存储，避免单独部署数据库，直接启动jar包，自动生成。
上传的图标，原型文件等，均以本系统resource方式存储（能通过链接访问），也是为了避免单独引入其他对象存储中间件，保持系统小巧。
本系统定位就是团队内部导航，不是那种提供很多公共服务的网址导航服务，作者在使用时往往一个分类就是一个项目名称，正在运行中的项目不会太多，所以分类没有做二级分类，当一个项目已经归档，就可以移除到历史分类中，以后需要还原回来即可。
本系统来源于作者在公司内部开源的一个项目，本来有一些自动登录、单点登录及卡片权限分配等功能，但这些都是需要公司有对应的公共服务才行，所以本系统就阉割成了只有一个管理员维护，管理员账号密码直接在application.yml中配置（V1.0.6新增在线修改功能），保留了一个私密卡片权限，需要登录才可看到。
原型文件的上传算是本系统一个亮点，也正是因为定位于研发团队内部使用，才有这样的功能。很多需求人员画了原型并不懂怎么静态部署，往往直接发压缩包给研发人员，再多改几次需求，压缩包就传来传去一大堆，非常的麻烦。本系统只需要需求人员将导出的原型文件打包成zip压缩包上传即可直接生成访问链接，需求人员用了都说好，研发需求关系更加和谐了。
系统使用vue但是并未前后端分离，一来是系统本来也小，懒得单独建前端工程，二来也是作者想尝试一下通过后端thymeleaf来完成前端页面的模块组件的开发，过程中也是碰到一些问题，只能说，这种方式并不适合用在实际的项目中，不然坑还是比较多的。

技术栈

前端

js框架：Vue
UI框架：ViewUI（iview升级版）

后端

Springboot
- SpringDataJpa：持久层框架
- thymeleaf：页面渲染
- SpringSecurity：后台登录
数据库：H2
其他
- ApacheCommons相关工具包
- Jsoup：解析目标网址的favicon.ico
- zip4j：对原型压缩包进行解压
- google.zxing：二维码生成

部署说明

方式一：手动部署

从Releases下载team-nav.tar.gz放到服务器上解压，对应修改config/application.yml文件，使用使用team-nav/bin/start.sh 启动项目即可。

方式二：docker部署

docker启动

docker run -d -p 8082:8080 \
-v /opt/team-nav/logs:/logs \
-v /opt/team-nav/database:/database \
-v /opt/team-nav/ext-resources:/ext-resources \
-e nav-name="团队导航服务" \
registry.cn-chengdu.aliyuncs.com/tuituidan/team-nav:1.1.1

参数说明：

logs、database、ext-resources分别将日志，数据库文件，额外资源（自定义图标和原型文件等）挂载出来。
nav-name：导航服务的名字，可不传，默认"团队导航服务"。

其他参数参考config/application.yml，可以将此文件挂载出来修改配置，也可通过docker的-e参数替换application.yml中的配置。

nginx部署（非必须）

如果不希望因为本服务停掉导致原型也无法访问，可以在后台系统设置中设置原型通过nginx访问，nginx配置示例如下：

# 将/ext-resources/modules的请求地址拦截并访问到目录/opt/team-nav/team-nav/ext-resources/modules
location /ext-resources/modules {
	alias   /opt/team-nav/ext-resources/modules;
	index  index.html index.htm;
}

卡片图标放置

如图卡片图标选择图，如果希望出现该图标选择按钮，需要将一些自己常用的图标放置到/ext-resources/images/default文件夹下，图标文件名会用于搜索。

本源码提供了一些图标，将docs文件夹下的default文件夹拖到/ext-resources/images下即可。

如果系统已经启动再放图标进去，就需要重启系统进行加载，主要是考虑这个操作不多，就不考虑定时刷新了。

版本说明

1.1.1
- 优化细节
  - 分类图标选择和卡片图标选择后关闭下拉弹窗
  - 卡片编辑时原型压缩包未重新上传不重复执行解压逻辑
  - 卡片添加弹窗增加保存并继续添加按钮，保存卡片数据后不关闭弹窗，方便快速添加
  - 卡片图标在进行选择，上传或输入文字生成图标后直接选中
  - 登录页面添加自动登录选择框，勾选后，首页和登录页都会自动登录，主动退出登录将移除自动登录选择。
- 缺陷处理
  - 解决左侧菜单收起时菜单显示个数减少问题
  - 解决IE下因css变量导致的样式问题
1.1.0
- 修复添加倒计时结束时间报错bug
- 新增布局大小切换功能
- 支持网站LOGO在设置中修改
1.0.9
- 首页卡片响应式显示，不再固定一排4个，根据浏览器宽度显示3-5个
- 后台分类管理表格和卡片管理表格不再默认支持拖动排序，可拖动情况下会导致无法复制行内数据，可通过开关手动开启排序
- 解决IE下侧边栏收起时，从侧边栏滑到卡片区域会闪动的问题
1.0.8
- 解决首页搜索卡顿问题
- 图片图片支持所有图片格式
- 首页添加回到顶部功能
- 部分样式和结构优化
1.0.7
- 修复默认图标被删除的bug
- 优化部分样式
- 新增发布倒计时功能（详见功能说明-发布倒计时）
1.0.6
- 优化调整了一些页面样式。
- 解决IE下因tooltip导致首页面抖动问题。
- 系统设置页面新增密码修改功能(系统设置图)，默认关闭，页面不显示密码修改框，需要通过yml配置中的change-password.enable开启。
  - 该配置关闭时，密码修改还是老方式，通过修改yml中的spring.security.user.password配置来修改密码。
  - 该配置开启时，系统设置页面才会出现密码修改框，密码将存入数据库，修改配置中的密码将不会生效，但首次启动密码读取的仍然是配置文件中的密码。
  如果并不希望密码随便就能被其他成员修改，请谨慎开启，毕竟是大家共用一个用户。
- 系统设置页面新增网站标题修改，首次启动会读取yml中的nav-name配置值。
1.0.5
- 优化了一些页面样式。
- 解决登录页面未能读取错误信息问题。
- 登录页面添加记住密码功能。
1.0.4
- 获取链接的favicon.ico添加超时去掉遮罩，避免因失败导致阻断表单提交。
- 二维码卡片也支持点击跳转（忘了之前为什么弄成不跳转）。
- 文字图标不再截取标题前两个字符，直接给出单独的输入框。
- 首页搜索不区分大小写，且不再实时搜索，需要按回车或者点击搜索框中的icon。
- 解决IE下搜索中文报错，二维码无法显示问题（只有首页支持了IE访问，建议尽量不使用IE）。
- 左侧菜单收起和展示记到localStorage中。
1.0.3
- 解决因升级springboot导致缓存失效bug。
- 解决管理页面手动输入地址，右侧菜单没有选中实际菜单的bug。
- 增加批量移除和批量还原功能。
1.0.2
- 增加根据配置开启和关闭登录功能
  
  yml中login.enable可配置开启关闭登录功能，默认true开启，配置为false后进入后台将不再需要登录，也不再支持私密卡片功能。
1.0.1
- 修复了一些bug
- 优化了一些样式
- 添加了卡片常用图标选择功能
- 卡片类型增加了二维码类型，注意如果是从老版本升级到此版本，原来card表的type字段的数据，1矫正为default，2矫正为zip，主要考虑这样更有意义一些，方便后续扩展其他类型。
1.0.0
- springboot从2.2.10.RELEASE升级到2.7.3
- 默认的h2数据库从v1升级到v2，不兼容v1，建议直接部署team-nav:1.0.0，然后将数据手动迁移到新库
0.0.1-SNAPSHOT

没有正式发布