# robot-init

**Repository Path**: hjmeng/robot-init

## Basic Information

- **Project Name**: robot-init
- **Description**: 初始化机器人
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-26
- **Last Updated**: 2021-05-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 初始化的机器人架构
## 场景

1. 每次搭建新包架构的时候需要从新配置架构

## 设计和思路

1. 初始化一个纯净项目[项目不包含任何框架类结构]
1. 保持项目的纯净化
1. 编写一个脚手架用于快速搭建项目

## 项目架构

```sh
.
├── data               # 数据存放
├── docs               # 说明文档
├── plan               # 计划文档
├── src                
│   ├── config              # 全局配置
│   ├── controller          # 控制器
│   ├── service             # 共享服务
│   ├── timedTask           # 定时任务
│   │   ├── config.ts         # 任务规则配置
│   │   ├── task.server.ts    # 定时任务服务
│   │   ├── utils.ts          # 数据处理方法
│   │   └── README.md         # 文档说明
│   ├── utils               # 工具库
│   └── bootstrap.ts        # 机器人启动入口
├── test                # 测试文件
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── tsconfig.json 
├── package-lock.json            
├── README.md
└── package.json   

```

## 安装教程

```shell

git clone https://gitee.com/hjmeng/robot-init.git   # 克隆项目到本地
cd robot-init                                       # 进入项目根目录
npm i                                                 # 安装包依赖

```
### 启动脚本

```shell
#------------- demo --------------#
npm run start          # 启动开发环境

#------------- build --------------#
npm run build          # 打包npm

#------------- lint --------------#
npm run lint         # 启动lint检测

npm run lint:fix     # 启动lint修复

#------------- test --------------#
npm run test         # 启动测试检测

```
#### 分支说明

1. master           默认分支

1. develop          调试分支

#### 参与贡献

1.  Fork 本仓库

2.  新建 Feat_xxx 分支

3.  提交代码

4.  新建 Pull Request