# node-pocket

**Repository Path**: moyinzi/node-pocket

## Basic Information

- **Project Name**: node-pocket
- **Description**: 将 node 的点滴装进口袋吧！少年 ^_^
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-05-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# node-pocket

#### 项目介绍
将 node 的点滴装进口袋吧！少年 ^_^

#### 软件架构

```
|-- cli/  --  脚手架工具（详见使用说明）
|-- doc/  --  计划、资料、资源
| |-- common/  --  通用文件、配置（不在这使用，要用请复制）
| |-- plans/  --  计划
| `-- resources/  --  资料
|-- playground/  --  游乐场（详见使用说明）
| |-- example/  --  样例
| |-- myz/  --  自己的一级目录
| | `-- another-example/  --  另一个样例
| `-- .gitignore  --  可忽略两级目录下的依赖
|-- store  --  组件库（如 storybook 之类的）
|-- workplace/  --  主工作空间（详见使用说明）
|-- LICENSE  --  Apache2.0 开源许可
`-- README_**.md  --  README 文档
```

#### 安装教程

##### 全局安装

1. 先安装 nodejs ，linux/unix 下推荐使用 nvm 或 n 安装，便于版本管理。
2. 推荐安装 yarn 代替 npm 作为包管理。
3. 推荐在开发环境使用 nodemon ，在生产环境使用 pm2 。

##### 局部安装

1. 执行 `yarn` 即可 。

#### 使用说明

##### playground

+ 可用于使用第三方脚手架、自己搭建环境
+ `.gitignore` 可忽略两级目录下的依赖（见两个样例）
+ 不推荐超过两级的目录，若强行使用，自行写 `.gitignore`
+ 建议一级目录自己的名字，二级目录项目名

##### cli

###### 结构

```
|-- scripts/  --  脚本
|-- template/  --  脚手架模板
|-- index.js  --  入口
`-- package.json  --  依赖等
```

###### 说明

> 暂无

##### workplace

###### 结构

```
|-- config/  --  运行配置
| |-- components/ --  拆分开来的配置模块
| |-- env/  --  配置模块的整合环境
| `-- index.js  --  整合环境的运行入口
|-- docker/  --  容器
| |-- env/  --  运行环境
| | |-- origin-0123456789/  --  原始镜像的实例
| | | | -- lib/  --  实例依赖
| | | | -- src/  --  源代码
| | | | -- www/  --  实例静态资源
| | | ` -- index.js  --  实例入口
| | |-- .gitignore  --  忽略实例和 local.ini
| | `-- local.ini  --  本地运行环境配置
| `-- images/  --  镜像仓库
|   |-- zhy/  --  某仓库
|   |-- myz/  --  主仓库
|   | `-- origin/  --  原始镜像仓库
|   |   `-- origin-v0.0.1.npk  --  原始镜像
|   `-- store.ini  --  仓库配置
|-- etc/  --  其它
|-- lib/  --  通用依赖（项目、镜像实例无关）
|-- scripts/  --  脚本
|-- www/  --  通用静态资源（项目、镜像实例无关）
| |-- resources/  --  图片等（不要上传太多太大）
| |-- scripts/  --  通用脚本
| | |-- xxx/  --  某脚本（不推荐添加所有版本，除非是本项目里迭代开发的）
| | | `-- xxx-v0.0.1.js  --  推荐的添加方式（使用到的各个版本）
| | | `-- xxx.js  --  推荐的添加方式（默认、常用版本）
| | `-- xxx.js  --  不推荐的添加方式
| `-- styles/  --  通用样式
| | |-- yyy/  --  某样式（不推荐添加所有版本，除非是本项目里迭代开发的）
| | | `-- yyy-v0.0.1.css  --  推荐的添加方式（使用到的各个版本）
| | | `-- yyy.css  --  推荐的添加方式（默认、常用版本）
| | `-- yyy.css  --  不推荐的添加方式
|-- index.js  --  入口
`-- package.json  --  依赖等
```

###### 说明

> 暂无

##### other

1. `*.todo` 请使用插件编辑，比如 `vscode` 的 `Todo+`

#### 参与贡献

1. Fork 本项目
2. 新建 Feat_xxx 分支（feature 分支）
3. 提交代码
4. 新建 Pull Request