# FocusDoc

**Repository Path**: dynamicant/FocusDoc

## Basic Information

- **Project Name**: FocusDoc
- **Description**: FocusDoc用户手册
- **Primary Language**: JavaScript
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-01-16
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FocusDoc

#### 介绍
FocusDoc用户手册

#### 软件架构
使用nextjs作为应用层框架

## src目录结构
├─public         -- 图片等静态资源
├─server         -- 服务端相关
├─src            -- 前端源代码
| └─components       -- 公共组件
| |─pages            -- 所有落地页
| | |─[pageName]         -- 落地页
| | | └─ redux                    -- 页面redux  
| | | |  └─ actions.js                -- action
| | | |  |─ actionTypes.js            -- 常量
| | | |  |─ reducer.js                -- reducer
| | | |  |─ saga.js                   -- 异步请求
| | | |─ views                    -- 页面显示jsx
| | | |─ index.js                 -- 页面对外暴露文件
| | | |─ [pageName].module.scss   -- 页面样式
| | |─_app.js            -- 应用顶层包裹，注入redux和redux-saga
| |─api              -- 接口
| |─styles           -- 公共样式
| |─rootReducer      -- 根级reducer，组合每个页面和公共组件的reducer
| |─rootSaga         -- 根级saga，组合每个页面和公共组件的saga
| |─store            -- 创建store，注入中间件
├─.babelrc        -- babelrc配置文件
├─next.config.js  -- 项目配置文件、包括webpack的配置以及next自己的一些配置

#### 安装教程

1.  安装依赖 npm install
2.  开发环境 npm run dev
3.  生产环境打包 npm run build    生产环境预览 npm start

#### 使用说明

1.  xxxx
2.  xxxx
3.  xxxx

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 码云特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5.  码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)