doc:for app

TalkingData · Feb 18, 2019 · 98a3673 · 98a3673
1 parent b910514
commit 98a3673
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 22 deletions.
diff --git a/scripts/service.js b/scripts/service.js
@@ -1,11 +1,12 @@
 /**
- * run app
+ * run service
  */
 const shell = require("shelljs");
 module.exports = (function() {
   if (shell.which("node")) {
     shell.cd("src/service");
     shell.echo("Start service...");
+    shell.exec("npm run tsc");
     shell.exec("npm run start:db & npm start");
     shell.echo("Service is running...");
     shell.exit();

diff --git a/src/app/README.md b/src/app/README.md
@@ -1,11 +1,11 @@
 # fa-monitor
 
-> 前端错误监控
+> 云诊
 
 # 目录结构
 
 ```
-├── build                      // 构建相关  
+├── build                      // 构建相关
 ├── config                     // 配置相关
 ├── src                        // 源代码
 │   ├── assets                 // 图片 样式等静态资源
@@ -26,7 +26,7 @@
 
 ## Build Setup
 
-``` bash
+```bash
 # install dependencies
 npm install
 

diff --git a/src/app/package.json b/src/app/package.json
@@ -2,8 +2,6 @@
   "name": "pecker-cloud",
   "version": "1.0.0",
   "description": "pecker",
-  "author": "TD",
-  "private": true,
   "scripts": {
     "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
     "start": "npm run dev",

diff --git a/src/sdk/.gitignore b/src/sdk/.gitignore
@@ -5,7 +5,7 @@
 /tmp
 /out-tsc
 /test
-/yunzhen
+/pecker
 
 # dependencies
 /node_modules

diff --git a/src/sdk/package.json b/src/sdk/package.json
@@ -13,11 +13,11 @@
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.tenddata.com:git/fa-monitor-sdk.git"
+    "url": "https://github.com/TalkingData/pecker-c"
   },
   "keywords": [],
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "devDependencies": {
     "eslint": "^5.9.0",
     "lodash": "^4.17.11",

diff --git a/src/sdk/rollup.config.js b/src/sdk/rollup.config.js
@@ -9,7 +9,6 @@ export default {
   output: {
     file: "pecker/index.js",
     format: "cjs"
-    // name:'YZMonitor'
   },
   plugins: [
     typescript({ module: "CommonJS" }),

diff --git a/src/service/README.md b/src/service/README.md
@@ -1,33 +1,32 @@
 ## QuickStart
 
 ### Development
-安装VS Code + eggjs插件（在vscode 插件库中搜索eggjs，第一个就是）
+
+安装 VS Code + eggjs 插件
 
 ```bash
-git clone git@gitlab.tenddata.com:git/fa-monitor-services.git
-cd fa-monitor-service
 npm install
 ```
 
-启动mongoDB
+启动 mongoDB
+
 ```bash
-npm run startdb
+npm run start:db
 ```
 
-在VS Code中打开代码
-参考 https://github.com/eggjs/vscode-eggjs 进行开发调试[eggjs]: 
+在 VS Code 中打开代码
+参考 https://github.com/eggjs/vscode-eggjs 进行开发调试[eggjs]:
 ![](https://github.com/eggjs/vscode-eggjs/raw/master/snapshot/debugger.gif)
 
-
 ### Typegoose
-model的定义我们用到了Typegoose，参考 https://github.com/szokodiakos/typegoose
-Typegoose使用TS的注解将普通的TS类声明为mongoos的Model，这些类可以同时作为实体类（pojo）和 mongoos 的model使用。
+
+model 的定义我们用到了 Typegoose，参考 https://github.com/szokodiakos/typegoose
+Typegoose 使用 TS 的注解将普通的 TS 类声明为 mongoos 的 Model，这些类可以同时作为实体类（pojo）和 mongoos 的 model 使用。
 
 ### Deploy
 
 ```bash
-$ npm run tsc
-$ npm start
+$ npm run tsc && npm start
 ```
 
 ### Npm Scripts