liweichun
/
my-bookmark
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updata README.md

This commit is contained in:
luchenqun 2018-12-16 20:44:05 +08:00
parent 57fe592d02
commit a31b2cf0ec
2 changed files with 188 additions and 189 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -20,7 +20,7 @@
3 主要功能(开发计划) 3 主要功能(开发计划)
------- -------
- [x] 需要注册账号用户。 - [x] 需要注册账号用户。
- [x] 网站展示有三种展示方式：导航，标签，列表，卡片。其中导航以分类展示，分类顺序可以在书签分类下面拖动编辑。按照点击的次数从高到低在每个分类里面提取16个书签，再按照最近添加的书签提取前面的16个书签，然后合并起来。标签是一个快捷方式。列表以表格展示，显示书签详细类容，按照点击次数优先显示，点击次数相同，则按添加顺序优先。卡片以卡片方式显示，按照最近添加优先显示。这几种展示方式，可以在设置里面默认一种你常用的方式。 - [x] 网站展示有三种展示方式：导航，标签，列表。其中导航以分类展示，分类顺序可以在书签分类下面拖动编辑。按照点击的次数从高到低在每个分类里面提取16个书签，再按照最近添加的书签提取前面的16个书签，然后合并起来。标签是一个快捷方式。列表以表格展示，显示书签详细类容，按照点击次数优先显示，点击次数相同，则按添加顺序优先。这几种展示方式，可以在设置里面默认一种你常用的方式。
- [x] 在书签分类里面，可以更新分类，删除分类，新增分类，对分类显示进行排序。分类的标签默认按照添加日期展示，但是可以点击表格的标题，按照点击次数，添加日期，最后点击从大到小进行排序。 - [x] 在书签分类里面，可以更新分类，删除分类，新增分类，对分类显示进行排序。分类的标签默认按照添加日期展示，但是可以点击表格的标题，按照点击次数，添加日期，最后点击从大到小进行排序。
- [x] 可以按照指定添加时间段，指定分类目录，指定网址关键字等进行查询。 - [x] 可以按照指定添加时间段，指定分类目录，指定网址关键字等进行查询。
- [x] 添加书签的时候，会自动获取title，供用户编辑。其中：Insert键打开添加页面，再次按Insert键保存书签，Esc取消添加。 - [x] 添加书签的时候，会自动获取title，供用户编辑。其中：Insert键打开添加页面，再次按Insert键保存书签，Esc取消添加。
@ -29,20 +29,20 @@
- [x] 可以将搜索到其他用户的书签转存为自己的书签。 - [x] 可以将搜索到其他用户的书签转存为自己的书签。
- [x] 可以将书签导出来，然后导入到浏览器。 - [x] 可以将书签导出来，然后导入到浏览器。
- [x] 在热门标签里面，有在网上找的热门书签。可以转存收藏到自己书签里面，快捷键R随机查看热门书签。 - [x] 在热门标签里面，有在网上找的热门书签。可以转存收藏到自己书签里面，快捷键R随机查看热门书签。
- [x] 新增备忘录功能，有时候随手要做点纪录，就方便了。任意界面按快捷键A增加备忘录。双击备忘录可查看详情！ - [x] 新增备忘录功能，有时候随手要做点纪录，就方便了。任意界面按快捷键A增加备忘录。双击备忘录可查看详情！亦可分享备忘。
- [x] 在设置的全局链接，可设置快捷键，用来在任何页面，快速打开设置的链接。 - [x] 在设置的全局链接，可设置快捷键，用来在任何页面，快速打开设置的链接。
- [x] 增加[Chrome插件](https://chrome.google.com/webstore/detail/%E4%B9%A6%E7%AD%BE%E5%BF%AB%E9%80%9F%E6%B7%BB%E5%8A%A0/paajmalhmjgdihaikmdfiplfmjlnkjgp)，可在任意界面快速添加书签至系统。 - [x] 增加[Chrome插件](https://chrome.google.com/webstore/detail/%E4%B9%A6%E7%AD%BE%E5%BF%AB%E9%80%9F%E6%B7%BB%E5%8A%A0/paajmalhmjgdihaikmdfiplfmjlnkjgp)，可在任意界面快速添加书签至系统。
- [x] 适配手机平板，手机端请访问[m.mybookmark.cn](http://m.mybookmark.cn/)。 - [x] 适配手机平板，手机端请访问[m.mybookmark.cn](http://m.mybookmark.cn/)。
4 主要用到的模块说明 4 主要用到的软件与模块说明
------------------ ------------------
**Node.js**：`v6.6.0` 用来做后台服务。 **Node.js**：`v8.12.0` 用来做后台服务。
**MySQL**: `v5.17.7`用来做数据存储。 **MySQL**: `v5.7.23`用来做数据存储。
**AngularJS**：前端JavaScript框架。 **AngularJS**：`v1.5.8`前端JavaScript框架。
**jQuery**: 本来用了AngularJS是不需要再使用jQuery了的。但是有些功能AngularJS要大费周章才能完成，jQuery一句代码就能解决。所以还是忍不住将它导入了进来。 **jQuery**: `v3.1.1`本来用了AngularJS是不需要再使用jQuery了的。但是有些功能AngularJS要大费周章才能完成，jQuery一句代码就能解决。所以还是忍不住将它导入了进来。
**MongoDB**：`v2.6.10`后台保存登陆的session。 **Redis**：`v3.0.6`后台保存登陆的session。
**Semantic**：由于没有美工人员，自己开发的，不想界面太丑，用了这套UI。 **Semantic**：`v2.4.0`由于没有美工人员，自己开发的，不想界面太丑，用了这套UI。
5 目录结构 5 目录结构
--------- ---------
@ -143,7 +143,7 @@ my-bookmark/
"cheerio": 用于后端的jQuery，解析从浏览器导出来上传到服务器的书签html文件 "cheerio": 用于后端的jQuery，解析从浏览器导出来上传到服务器的书签html文件
"cookie-parser": 处理每一个请求的cookie "cookie-parser": 处理每一个请求的cookie
"crypto": 加密模块，主要用来加密用户的密码 "crypto": 加密模块，主要用来加密用户的密码
"debug": 这个好像没用到，看名字好像调试的。 "debug": Node.js后台日志模块，bin/www用到。
"download": 主要用来下载书签的favicon文件 "download": 主要用来下载书签的favicon文件
"express": Web 应用程序框架 "express": Web 应用程序框架
"express-session": session模块 "express-session": session模块
@ -170,7 +170,7 @@ use mybookmarks; //选择刚创建的数据库。
source /home/lcq/schema.sql; // 执行schema.sql文件创建数据库表格。注意，将路径换为你schema.sql所在路径。 source /home/lcq/schema.sql; // 执行schema.sql文件创建数据库表格。注意，将路径换为你schema.sql所在路径。
``` ```
3、安装Redis 安装教程。如果不会，请戳教程[Redis 安装教程](http://baidu.luchenqun.com/?redis%20%E5%AE%89%E8%A3%85 "Redis 安装教程")，安装完成之后如果Redis没有启动，请启动Redis。 3、安装Redis 安装教程。如果不会，请戳教程[Redis 安装教程](http://baidu.luchenqun.com/?redis%20%E5%AE%89%E8%A3%85 "Redis 安装教程")，安装完成之后如果Redis没有启动，请启动Redis。
4、安装Node.js。Node.js版本至少要求6.0以上。不会的话，请按照上面步骤1、3提供的方法自行解决。 4、安装Node.js。Node.js版本至少要求8.0以上。不会的话，请按照上面步骤1、3提供的方法自行解决。
5、克隆代码`git@github.com:luchenqun/my-bookmark.git`，切换到项目根目录下面，执行`npm install`安装package。 5、克隆代码`git@github.com:luchenqun/my-bookmark.git`，切换到项目根目录下面，执行`npm install`安装package。
6、更新/database/db.js文件的dbConfig配置，将你mysql的数据信息更新上去。 6、更新/database/db.js文件的dbConfig配置，将你mysql的数据信息更新上去。
7、如果上面的都做好了，在项目根目录下面执行`node ./bin/www`，如果是开发，可以使用`npm start`。 7、如果上面的都做好了，在项目根目录下面执行`node ./bin/www`，如果是开发，可以使用`npm start`。

1
routes/api.js
View File

@ -1,5 +1,4 @@
var api = require('express').Router(); var api = require('express').Router();
var mysql = require('mysql');
var crypto = require('crypto'); var crypto = require('crypto');
var read = require('node-readability'); var read = require('node-readability');
var db = require('../database/db.js'); var db = require('../database/db.js');