README.md

README

Index

• README
  • Index
  • 1️⃣Tech Stack
    • Application
    • Service
    • CI / CD
    • ETC
  • 2️⃣ERD
  • 3️⃣Endpoint 정리
  • 4️⃣실행 방법
    • 주의사항
    • 필수 Plugin, 준비사항
    • Annotation Processor
    • 필요 VMOptions
    • Run

1️⃣Tech Stack

Application

Service

CI / CD

ETC

2️⃣ERD

3️⃣Endpoint 정리

Note

내용이 많아 위키로 기록을 하였습니다. 위키 링크만 참조하는점 양해 부탁드립니다.

• Endpoint 링크 바로가기

4️⃣실행 방법

주의사항

Warning

해당 방법은 Mac을 기반하여 Intellij를 기준으로 설명이 되어있습니다.
또한 문서의 설명은 Intellij 설정방법를 토대로 제작되었습니다.

필수 Plugin, 준비사항

• LomBok
• OpenJDK 17

Annotation Processor

1. Mac을 기준으로 Intellij IDEA → Settings클릭
2. Build, Execution, Deployment → CompilerAnnotation Processors
3. Enable annotation processing 체크표시

필요 VMOptions

Warning

6개의 항목 모두 비밀키로, 현재는 사용이 불가능합니다.
구글 계정을 사용하실 경우, 이메일과 앱 비밀번호를,
Storage Object의 경우 NCP의 Object Strage Key를,
papago의 API키는 NCP에서 발급받아 입력하시기 바랍니다.

-Dnaver.storage.access-key=yXOrGQFmk7BfURVyU5Dw
-Dnaver.storage.secret-key=bv0q1CSqr8kPEjZmyTA5qSreGz4FWUTJtJFObiO6
-Dspring.mail.username=${자신의 구글 계정을 기록하세요}
-Dspring.mail.password=${자신의 구글 앱 패스워드를 기록하세요}
-Dpapago.header.X-NCP-APIGW-API-KEY-ID=ybakk0x770
-Dpapago.header.X-NCP-APIGW-API-KEY=DQxOkhtAKEqN61A5vGrp5mYW1j66Qi7vR0R7fJh5

Run

• HookKiller.server위치의 ServerApplication.java의 Main메소드를 Run하시면 됩니다.