# 🔮 Friday-GPT

> 📜 이 프로젝트는 GPT 에 R&R을 부여해서 단계 별로 프로그래밍을 진행 시키는 프로젝트입니다.

> (⚠️ **_Experimental_**) 이 프로젝트는 현재 실험 중에 있으며, Open A.I 토큰을 소모할 수 있으므로 실행 시 주의가 필요합니다.

<br />

[![Watch the video](https://i.imgur.com/MkCYunz.png)](https://twitter.com/hmartapp/status/1645252545668067328)

## 💬 프로젝트 설명

> 이 프로젝트는 프로그래밍을 GPT에게 시키되 각각 단계 별로 A.I에게 R&R 을 부여합니다.

> 👩🏻‍⚕️ Architect -> 🕵🏻‍♀️ Tech Evangelist -> (👩🏻‍💻 Lead -> 👩🏻‍🏭 Junior -> 👩🏻‍🚀 QA -> 👩🏻‍🚒 Senior)

<br />

### 1. 👩🏻‍⚕️ Architect

> 최초 요청에 따른 설계를 담당합니다. 먼저 기획안을 5개 뽑아낸 후 가장 나은 기획을 고르며, 개발 기획 퀄리티가 높아질때까지 최대 10회 기획을 개선하기 위해 자체적으로 개선 회의를 진행해서 기획을 개선합니다.

### 2. 🕵🏻‍♀️ Tech Evangelist

> 아키텍트가 완성한 기획안을 토대로 프로젝트 스펙 및 참조 기술 목록을 작성합니다.

### 3. 👩🏻‍💻 Lead Programmer

> 최초로 프로그래밍을 진행하고 실제 이용자에게 리뷰를 요청한 다음 요청사항에 개발 사항을 수정합니다.

### 4. 👩🏻‍🏭 Junior Programmer

> 테스트 스크립트를 작성하고 개발된 기능을 안정적이게 하는 방향을 모색해서 보완 개발합니다.

### 5. 👩🏻‍🚀 Quality Assurance

> 실제 테스트 결과를 받아보고 테스트 결과와 원인 및 해결법을 분석한 보고서를 생성합니다.

### 6. 👩🏻‍🚒 Senior Programmer

> 작성된 프로그램과 발생된 오류와 QA 보고를 읽은 후 스크립트를 수정해서 에러 해결시도합니다.

<br />

### **리팩토링 절차**

> Lead 부터 Senior 까지의 과정은 실제 테스트를 모두 통과할 때 까지 반복됩니다.

- (현재 Junior, QA, Senior 단계는 개발 중에 있습니다.)

<br />

## 💬 프로젝트 실행 방법

> 아래 명령어를 입력해서 프로젝트를 클론한 후 인스톨 해주세요. (이 프로젝트에는 Node.JS 가 필요합니다.)

```bash
git clone https://github.com/hmmhmmhm/friday-gpt
cd ./friday-gpt
npm install
```

> .env 파일을 프로젝트 상단에 생성한 후 아래 내용을 체워줍니다.

> **_OPENAI_API_KEY_** 는 동작에 필수적이며, 여기서 발급하실 수 있습니다. [Open A.I Get API keys](https://platform.openai.com/account/api-keys)

> **_AZURE_SPEECH_KEY_** 를 입력해주면 TTS 를 이용해서 진행과정을 알려줍니다. (정보를 넣지 않으셔도 됩니다.)

> **\*AZURE\_\*\*** 관련 입력 값은 여기서 발급하실 수 있습니다. [Azure Speech Services](https://portal.azure.com/?quickstart=true#view/Microsoft_Azure_ProjectOxford/CognitiveServicesHub/~/SpeechServices)

```bash
OPENAI_CHAT_MODEL=gpt-3.5-turbo # 또는 gpt-4
OPENAI_API_KEY=
AZURE_SPEECH_KEY=
AZURE_SPEECH_REGION=
AZURE_SPEECH_VOICE=ko-KR-SeoHyeonNeural
```

> src/input.ts 파일을 열어서 userRequest 변수에 원하는 개발 방향을 설정합니다.

```ts
export const userRequest =
  '문자열로 두 개의 숫자 값을 입력 받아서 마치 사람이 계산하는 방법처럼 각 단위의 숫자를 비교해서 무제한 길이로 사칙연산을 할 수 있는 Typescript 라이브러리를 작성해줘'
```

> 아래 명령어를 실행해서 A.I에게 요청을 보냅니다.

```
npm run dev
```

> 또는 다음과 같이 커맨드라인에서 prompt를 붙일 수도 있습니다.

```
npm run dev 여러가지 순열들을 제공해주는 Typescript 라이브러리를 제공해 줘
```

> 모든 결과파일은 result 폴더 안에 생성됩니다.

<br />

## ✨ Special Thanks

- **_[@antegral](https://github.com/antegral)_** 프라이데이 프로젝트를 위해 GPT-4 테스트 계정을 공유해주셨습니다 감사드립니다!

<br />

## ✅ 라이센스

> MIT Licensed.