jeromeyangtao / cnode-community Goto Github PK

express实现一遍cnode社区的接口

JavaScript 57.24% HTML 13.65% CSS 7.66% Smarty 0.25% Vue 21.20%

cnode-community's Introduction

前言

项目灵感的最初来源是cnode社区提供了一套开放API，很多前端就试着用它复现一遍cnode社区。不过访问cnode的大部分都是冲着学Node.js的，在学了点基础知识之后，就想着做个大一点的项目试试。正好看到社区提供了一套比较规范的接口，就试着自己实现一遍

预览

预览，移动端，建议切换Chrome的iPhone8模式下浏览。持续更新，还未完全成型。

技术栈

后端: express + mongodb + redis + JWT登录 + 单元测试 + 内存 + 性能调优 + 分布式 
前端: vue、vue-router、vuex、axios、es6开发，使用webpack构建工具编译打包项目

使用项目

后端部分：

1.克隆项目：      git clone https://github.com/JeromeYangtao/cnode-community
2.安装nodejs
3.安装依赖：      npm install
4.启动MongoDB
5.启动Redis
4.启动服务：      npm start

功能

项目目录说明

.
|-- bin                              // 脚步目录
|   |-- www.js                       // express启动文件
|-- logs                             // 日志
|-- middlewares                      //中间件
|-- mocks                            //测试用的模拟数据
|-- models                         
|-- profile
|-- public          
|-- routes                            //路由
|-- services                          //数据库
|-- tests                             //单元测试
|-- utils                             //封装一些小工具
|-- views                             //视图
|-- .gitignore
|-- app.js                            // 程序入口文件
|-- cipher.js                         //加密文件
|-- dump.rdb       
|-- errors.js
|-- package.json                      // 配置项目相关信息，通过执行 npm init 命令创建
|-- package-lock.json                 //npm 版本锁定
|-- README.md                         // 项目说明

.

用到的接口

    以下 api 路径均以 http://yangtao.biz/api/v1 为前缀

    /**
    *
    * @api post /accesstoken
    * @apiDescription accesstoken登录(loginName)
    *
    */

    /**
    *
    * @api get /user/:loginName
    * @apiDescription 通过loginName获取用户
    *
    */

    /*
     * 获取已读和未读消息
     * get /messages 
    */

    /**
    *
    * @api get /topics 主题首页
    * @apiDescription 获取首页的topics列表
    * @apiParam {Number=0} page 页数
    * @apiParam {String=all} tab topics分类 目前有all
    * @apiParam {Number=10} limit  每一页的topics数量
    *
    */

    /**
    *
    * @api get /topics/:id 主题详情
    * @apiDescription 通过id获取topic
    *
    */

    /**
    *
    * @api post /topics
    * @apiDescription 创建帖子
    * @apiParam {String} accessToken 用户的 accessToken
    * @apiParam {String} title 标题
    * @apiParam {String} tab 目前有 ask share job dev
    * @apiParam {String} content 主体内容
    *
    */