https://github.com/sivagao/goblin-doc

docs for goblin project
https://github.com/sivagao/goblin-doc

Last synced: about 1 month ago
JSON representation

docs for goblin project

• Host: GitHub
• URL: https://github.com/sivagao/goblin-doc
• Owner: sivagao
• License: mit
• Created: 2014-04-16T13:58:45.000Z (over 10 years ago)
• Default Branch: gh-pages
• Last Pushed: 2014-06-25T03:36:00.000Z (over 10 years ago)
• Last Synced: 2024-10-14T11:11:13.736Z (3 months ago)
• Homepage: http://gaohailang.github.io/goblin-doc/
• Size: 453 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Goblin 项目 总结

### 整个项目先按照代码类型划分：

- templates

- scripts

- styles(包含images)

### 各个类型的代码分为：

- base

- \ - 具体业务模块

### base代码：

- [基础样式](styles.md)

    - Adonis

    - component

        - base - 设置全局的字体，颜色link，等

        - ng-animate - angular's animation hook

        - form 

        - `BASIC UI COMPONENT` dropdown, bubble, popup, help-tips，等

        - `DEVCENTER UI COMPONENT` protocol, step-progress-bar, icon, tab-btn, 等

- 基础模板 - 财务信息模板，分页，导航， 步骤条， 帐号avataor & menu， date range picker等 

- 基础脚本

    - pmtAccount

    - pmtHttp

    - pmtDirectives - 给之前的模板封装成directive并且加入controller 或者dom linker 函数

    - pmtUploader -> 封装fineuploader jquery插件为支持promise的上传组件

    - pmtFilters - 全局使用的filters: humanBytes, percentage， 

    - pmtPagination

    - pmtBusyDirective

    - pmtFinancial

    - pmtAlert（复杂的组件包含directive, service[如addAlert etc]）

### 业务 \代码：

- account 帐号创建和设置

- ad 广告创建

- admanagement 广告管理和数据

- app 应用上传

- charge - 账单 （申请充值和发票）

- clearing - 结算（结算单和财务信息修改）

- console - 单机联运和管理

- [home](app/home.md) - 首页（我的应用，各应用统计数据）

- network - 网盟广告（创建和管理）

- online - 网游联运创建

- open - oem 厂商的配置后台

- opmanagement - 网游管理（SDK下的订单查询，成功失败订单，等）

- package - 礼包创建

### 其他代码：

- vender - 第三方非bower管理的library

- config.js - 给require.js 用的配置文件

### 业务\代码组成：(举例network, home)

- styles/home.scss

- scripts/home/

    - index.js

    - services.js

    - directives.js

    - routes.js

- templates/home

    - app-list.html

    - home.html

    - myapp.html

    - stats.html

### build & deploy & develop 开发，构建，发布

- 配置抽取： 抽出配置信息到gruntUitls.js中（如copy, replace, requirejs, connect settings(proxy, modRewrite等)）

- multi-index.html优化

    - snippet 插入，GAsnippet, FrameworkSnippet抽取到单独文件

        - deploy 通过`replace`（对于framework.js的构建的hack）

        - develop 通过`connectInject`插入

    - 优化usemin, useminPrepare

        - home/index.html 引入 usemin 语法来单独完成framework.js的生成，然后deploy时候其他页面通过replace前的hook取得build & reversioned filename 并且替换

### Spec 专题

- [httpAuth](topics/http-auth.md)

- form validate （420， message directive和 input设置）

    - 特殊的input field情况（pmtScreenShowcase）

- GA insert

- 局部directive和外围通信

- [dataServices](topics/biz-data.md)：帮助controllers处理 业务资源请求和修改的http请求

### TODO:

- [x] 把这篇简要的文档， 改成markdown 形式， 修饰下。

- [x] 更酷炫的见reveal.js中的效果

- [ ] keep your word! - 把一些设想的，但没有实施的很好的，去实施！