Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
binchoo committed Jul 23, 2022
1 parent c528022 commit 5800e49
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
22 changes: 11 additions & 11 deletions README-한국어.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,25 @@

챗봇 기능을 지원하는 백엔드 워크플로들과 그 의존성입니다.

**Application pacakge**
**응용 모듈**

`:application:lambda`
`:paimonganyu-app:paimonganyu`

**Dependent packages**
**의존 모듈**

`:application:infra`, `:domain`, `:awsutils`, `:hoyoapi`
`:paimonganyu-infra`, `:paimonganyu-domain`, `:paimonganyu-hoyoapi`, `:awsutils`

### 2. paimonganyu-skill

챗봇 유저 요청을 처리하고, 스킬 응답을 렌더링하는 스킬 서버 코드와 그 의존성입니다.

**Application package**
**응용 모듈**

`:application:chatbot`
`:paimonganyu-app:paimonganyu-skill`

**Dependent packages**
**의존 모듈**

`:application:infra`, `:domain`, `:ikakao`, `:hoyoapi`
`:paimonganyu-infra`, `:paimonganyu-domain`, `:paimonganyu-hoyoapi`, `:ikakao`

## 프로젝트 일지
[Notion: PaimonGanyu 엔지니어링](https://hollow-leotard-0e1.notion.site/PaimonGanyu-81337fdfe052499f98a2a347f30afbcd) 개인적인 프로젝트 일지입니다.
Expand Down Expand Up @@ -73,7 +73,7 @@ paimonganyu-skill 배포시 Amazon Elastic Beanstalk 응용으로서 CloudFormat

### applications.properties (required)

`:application> src> main> resources> applications.properties`
`:paimonganyu-app:paimonganyu-skill> src> main> resources> applications.properties`

```properties
amazon.ssm.hoyopass.publickeyname = HoyopassRsaPublicKey
Expand All @@ -95,7 +95,7 @@ listUserDailyCheck.maxCount = 4

### amazon.properties (optional)

`:application> src> test> resources> amazon.properties`
`:paimonganyu-app:paimonganyu-skill> src> test> resources> amazon.properties`

```properties
amazon.aws.accesskey=ASDFASDFASDFASDFASDF
Expand All @@ -115,7 +115,7 @@ amazon.ssm.hoyopass.privatekeyname = HoyopassRsaPrivateKey

### accounts.properties (optional)

`:application> src> test> resources> accounts.properties`
`:paimonganyu-app:paimonganyu-skill> src> test> resources> accounts.properties`

몇 가지 테스트는 기능 점검을 위해 실제 원신 계정을 요구합니다.

Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,25 @@ This repository contains two [CloudFormation stacks](https://docs.aws.amazon.com

The behind AWS workflows that support the chatbot's features, and dependencies.

**Application pacakge**
**Application module**

`:application:lambda`
`:paimonganyu-app:paimonganyu`

**Dependent packages**
**Dependent modules**

`:application:infra`, `:domain`, `:awsutils`, `:hoyoapi`
`:paimonganyu-infra`, `:paimonganyu-domain`, `:paimonganyu-hoyoapi`, `:awsutils`

### 2. paimonganyu-skill

The code of skill server that handles user requests and renders skill responses, and dependencies.

**Application package**
**Application module**

`:application:chatbot`
`:paimonganyu-app:paimonganyu-skill`

**Dependent packages**
**Dependent modules**

`:application:infra`, `:domain`, `:ikakao`, `:hoyoapi`
`:paimonganyu-infra`, `:paimonganyu-domain`, `:paimonganyu-hoyoapi`, `:ikakao`

## Engineering Wiki
[Notion: PaimonGanyu 엔지니어링](https://hollow-leotard-0e1.notion.site/PaimonGanyu-81337fdfe052499f98a2a347f30afbcd)
Expand Down Expand Up @@ -123,15 +123,15 @@ If any account authentication is not provided, those tests will fail. That being

## Makefile shortcuts

**Deploying the serveless workflows**
**Deploy the serveless workflows**

`make paimonganyu-prod version=1.0.0`

**Deploying the skill server**
**Deploy the skill server**

`make paimonganyu-skill-prod version=1.0.0`

**Running a local system test** (Needs at least three test accounts.)
**Run a local system test**

`make localtest`

Expand Down

0 comments on commit 5800e49

Please sign in to comment.