Skip to content

docs : README.md 작성#158

Merged
chuuminggg merged 13 commits into
mainfrom
docs/readme
Jun 3, 2026
Merged

docs : README.md 작성#158
chuuminggg merged 13 commits into
mainfrom
docs/readme

Conversation

@chuuminggg

Copy link
Copy Markdown
Member

🔥ISSUE

프로젝트 README.md 작성

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README.md to document the project's features, setup instructions, and performance troubleshooting details (such as indexing, Redis caching, and notification domain migration). The reviewer noted that the newly added .env configuration variables duplicate existing ones and are inconsistent, and suggested a consolidated template to clean up the documentation.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
Comment on lines +41 to +68
DB_HOST=
DB_PORT=
DB_NAME=
DB_ROOT_PASSWORD=
DB_USER=
DB_PASSWORD=
REDIS_HOST=
REDIS_PORT=
REDIS_PASSWORD=
KAKAO_CLIENT_ID=
KAKAO_CLIENT_SECRET=
NAVER_CLIENT_ID=
NAVER_CLIENT_SECRET=
JWT_SECRET=
JWT_ACCESS_EXPIRATION=
JWT_REFRESH_EXPIRATION=
JWT_TEMP_EXPIRATION=
DEFAULT_PROFILE_IMAGE_URL=
FRONTEND_URL=
FRONTEND_PROD_URL=
BACKEND_URL=
BACKEND_PROD_URL=
COOKIE_SECURE=
COOKIE_SAME_SITE=
COOKIE_DOMAIN=
NCP_ACCESS_KEY=
NCP_SECRET_KEY=
NCP_BUCKET_NAME=

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

새롭게 추가된 .env 설정 항목들(4168라인)과 기존에 작성되어 있던 설정 항목들(7083라인)이 중복되거나 서로 다른 변수명(예: JWT_SECRET vs JWT_SECRET_KEY)을 사용하고 있어 혼선을 줄 수 있습니다.

기존의 중복된 MySQL, JWT, Encryption 설정 부분을 제거하고, 새로 추가된 변수들과 통합하여 일관된 형식으로 정리하는 것이 좋습니다. 아래 제안을 적용하신 후, 기존의 70~83라인(중복된 # MySQL 이하 부분)은 수동으로 삭제해 주세요.

# Database (MySQL)
DB_HOST=
DB_PORT=
DB_NAME=
DB_ROOT_PASSWORD=
DB_USER=
DB_PASSWORD=

# Redis
REDIS_HOST=
REDIS_PORT=
REDIS_PASSWORD=

# OAuth (Kakao, Naver)
KAKAO_CLIENT_ID=
KAKAO_CLIENT_SECRET=
NAVER_CLIENT_ID=
NAVER_CLIENT_SECRET=

# JWT
JWT_SECRET=
JWT_ACCESS_EXPIRATION=
JWT_REFRESH_EXPIRATION=
JWT_TEMP_EXPIRATION=

# Application URLs & Settings
DEFAULT_PROFILE_IMAGE_URL=
FRONTEND_URL=
FRONTEND_PROD_URL=
BACKEND_URL=
BACKEND_PROD_URL=
COOKIE_SECURE=
COOKIE_SAME_SITE=
COOKIE_DOMAIN=

# NCP (Naver Cloud Platform)
NCP_ACCESS_KEY=
NCP_SECRET_KEY=
NCP_BUCKET_NAME=

@chuuminggg chuuminggg merged commit 4c2cd80 into main Jun 3, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant