# start-component

**Repository Path**: devsapp/start-component

## Basic Information

- **Project Name**: start-component
- **Description**: None
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-06
- **Last Updated**: 2021-10-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 概念说明

### 应用 application

应用 application 是 serverles devs cli 的启动对象，包含全局变量,以及服务。 [具体内容查看官方文档](https://github.com/Serverless-Devs/docs/blob/master/zh/yaml.md)

### 组件 component

component 是 serverless devs 执行的主逻辑单元，用户可以在组件里自定义不同的流程处理逻辑。 一个 component 可看做是一个 npm 包 (类似 java jar)

## 使用说明

本项目是开发 Serverless devs 组件 component 的标准模板，提供了日志打印，国际化，以及 文档生成样例。

## 前置条件

安装最新的 s 工具

```
npm i @serverless-devs/s -g
```

检查 s 版本，对照 local 和 remote 是否是最新

```
s -v
```

## 快速开始

### 1.组件下载

```
s init devsapp/start-component // 或者直接s init 后选择最后的Component 选项
```

### 2.输入项目名

根据你的自定义需求，输入需要名称 [projectName]

### 3.安装依赖

```
cd <projectName>  && npm i
```

### 4.监听编译

```
npm run watch
```

### 5.执行测试

```
cd example && s test
```

## 平台发布

### 注册 serverless devs 平台账号

```
s cli platform register
```

### 已有账号可以直接登录

```
s cli platform login
```

### 进行发布

在 <projectName> 根目录执行

```
npm run publish
```

### 发布完毕后测试

```
s cli <projectName>  -d
```

有接过输出则说明已经发布 ok，其他 s 生态的同学可以直接使用