diff --git a/README.md b/README.md index e99078b..aae140d 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,13 @@ # Emopic-BE +Emopic-BE 저장소에는 Emopic 프로젝트에 사용에서 주요 데이터에 대한 CRUD 기능을 하는 코드가 작성되어 있습니다. +## Table Of content - -## ERD -Screen Shot 2022-07-08 at 15 27 12 - -## 프로젝트 구조 -![image](https://github.com/Memento-Makers/Emopic-BE/assets/38587274/030cc919-19cd-49ab-be72-14f8165a780c) - -## 팀원 소개 -
-
- - - - - - - - - - - - - - - - - - - - - -
- 김다은 - - 오재석 - - 송승훈 -
- -
김다은
- - 		- -
오재석
- - 		- -
송승훈
- -
-
Frontend
- 		-
Bacekend, AI
- 		-
Bacekend, AI
-
-
-
+- [기술 스택](#기술-스택) +- [준비 하기](#준비하기) +- [실행 하기](#실행하기) +- [참고 내용](#참고내용) +- [기여 하기](#기여하기) ## 기술 스택 @@ -66,61 +15,107 @@ ![Java](https://img.shields.io/badge/java-11-%233178C6) + +### 라이브러리 + +![querydsl](https://img.shields.io/badge/querydsl-5.0.0-blue) + ### 프레임워크 ![Springboot](https://img.shields.io/badge/springboot-2.7.14-%236DB33F) -![Pytorch](https://img.shields.io/badge/pytorch-2.0.0+cu118-%23EE4C2C) -![Fastapi](https://img.shields.io/badge/fastapi-0.103.0-%23009688) -### Infra -![Nginx](https://img.shields.io/badge/nginx-1.25.2-%23009639) -### DataBase +## 준비하기 +- spring boot와 연결할 Database를 구성해주세요 +- Google Cloud Platform의 이미지 저장소를 만들고 credential.json 파일을 준비해 주세요 +- Caption 결과 번역을 위해 DeepL key 혹은 papago key를 준비해주세요 +- GPS 정보로 시도군 정보를 받아오기 위해 KakaoMap API Key를 준비해주세요 +- AI 서버와 연결을 위해 [Emopic-AI 저장소](https://github.com/Memento-Makers/Emopic-AI.git)를 참고해 AI 서빙 서버를 구축해주세요 + -![Mysql](https://img.shields.io/badge/Mysql-8.0.33-%234479A1) -![Redis](https://img.shields.io/badge/Redis-7.2-%23DC382D) -### 검색 +## 실행하기 -![elasticsearch](https://img.shields.io/badge/elasticsearch-8.9.1-%23005571) -![logstash](https://img.shields.io/badge/logstash-8.9.1-%23005571) +환경변수 설정 -## API 명세 -[Swagger API 명세](https://test.emopic.shop/swagger-ui/index.html) -![화면 캡처 2023-09-07 212846](https://github.com/Memento-Makers/Emopic-BE/assets/80192612/45fcbb3d-942c-4fe8-b41e-9f072e14f1a0) +#### 1. 레포지토리 클론 +```shell +git clone https://github.com/Memento-Makers/Emopic-AI.git +``` -# 시작하기 -## 설치 -프로젝트의 원격 저장소를 Fork 하여 깃허브 내계정으로 복사하기. +#### 2. 환경변수 설정하기 -Fork된 저장소를 git clone 명령으로 로컬 환경에 복사. +
-환경변수 설정 +``` +#Database +MYSQL_URL= +MYSQL_USERNAME= +MYSQL_PASSWORD= + +JWT_SECRET_KEY= +JWT_ACCESS_TOKEN_EXPIRE_TIME= +JWT_REFRESH_TOKEN_EXPIRE_TIME= + +#GCP +DURATION= +PROJECT_ID= +BUCKET_NAME= +KEY_PATH=credential.json (gcs access key) + +#inference-server +INFERENCE_URL= -## 기여하기 +#LOG +LOG_PATH= -### 이슈생성 -이슈를 생성 하기 전에 최신 버전의 프로젝트를 사용하고 있는지 확인하세요. +#DeepL +DEEPL_AUTH_KEY=<> -관련 이슈가 이미 존재하지 않는 경우 관련 [이슈 양식](.github/ISSUE_TEMPLATE)을 사용하여 새 이슈를 열 수 있습니다. +#Swagger +REQUEST_URL= +REQUEST_URL_DESCRIPTION=개발 서버 + +#CORS +CORS_LIST=http://localhost:*,http://your-domain.com + +#PAPAGO +PAPAGO_AUTH_ID=<> +PAPAGO_AUTH_KEY=<> + + +# 스케줄러 동작 -> 하루에 1번씩 예시 +SCHEDULE=0/0 0 0 1 * * + +#File upload max size +MAX_FILE_SIZE = 20MB +MAX_REQUEST_SIZE = 20MB + +#Kakao Map API # Kakao Map API Key +KAKAO_REST_API_KEY = <> +KAKAO_COORD_TO_REGION_URL = https://dapi.kakao.com/v2/local/geo/coord2regioncode -### 브랜치(Branch) 만들기 -기능 개선이나 추가,버그 수정 등의 작업을 위해 별도의 브랜치를 만들어 진행할 수 있습니다. -```bash -git branch [branch명] -git checkout [branch명] ``` -### 커밋 메시지 작성 -브랜치에 작업한 내용이 만족스러우면 커밋 메시지를 작성하고 push 할 수 있습니다. -커밋 메시지 작성시 작성 양식을 따라 주세요. +
+
-### Pull Request 작성 -변경이 완료되면 Pull Request 요청을 생성할 수 있습니다. +#### 3. docker image 빌드하기 +```shell +docker build -t . +``` + +#### 4. docker image 실행시키기 +```shell +docker run --env-file .env -v credential.json:/key.json -p 8080:8080 -d +``` + + +## 참고내용 + +### ERD +Screen Shot 2022-07-08 at 15 27 12 -Pull Request 작성시 [작성 양식](.github/pull_request_template.md)을 따라 주세요. +### API 명세 +[Swagger API 명세](https://dev.emopic.shop/swagger-ui/index.html) -작성 시 주의사항은 다음과 같습니다. -1. 제목은 해결하려는 이슈가 무엇인지 누구나 파악할 수 있도록 간명하게 작성한다. -2. 관련된 이슈가 있을 경우 해당 이슈의 게시물 번호를 함께 명시해준다. -3. 해결하려는 이슈의 간략한 내용, 수정/개선 방향등의 내용을 요약해서 작성한다. -4. 가급적 공손한 어투로, 무례하거나 공격적으로 느껴지지 않도록 작성한다. +## [기여하기](emopic/docs/contribute.md)