Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 환경 변수 설명 docstring 추가 #512

Merged
merged 1 commit into from
Jun 20, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions backend/src/env.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/* eslint-disable no-unused-vars */
/* eslint-disable import/prefer-default-export */

export declare global {
namespace NodeJS {
interface ProcessEnv {
/** 서버 실행 모드, 로깅 레벨 결정 */
NODE_ENV?: 'development' | 'production';

/** 집현전 프론트엔드 URL */
CLIENT_URL: string;

/** JWT 인증 토큰 시드 */
JWT_SECRET: string;

/** 국립중앙도서관 ISBN 서지정보 API 키 */
NATION_LIBRARY_KEY: string;

/** 네이버 도서 검색 API 클라이언트 아이디 */
NAVER_BOOK_SEARCH_CLIENT_ID: string;

/** 네이버 도서 검색 API 시크릿 */
NAVER_BOOK_SEARCH_SECRET: string;

/** 집현전 슬랙봇 OAuth 인증 토큰 */
BOT_USER_OAUTH_ACCESS_TOKEN: string;

// 42 API
/** 42 API OAuth 클라이언트 아이디 */
CLIENT_ID: string;

/** 42 API OAuth 클라이언트 시크릿 */
CLIENT_SECRET: string;

/** 42 API OAuth 리다이렉트 URL */
REDIRECT_URL: string;

/** 레포지토리 선택 모드 */
MODE: 'local' | 'RDS' | 'prod';

// local 또는 prod MODE에서
/** MySQL 데이터베이스 이름 */
MYSQL_DATABASE?: string;

/** MySQL 데이터베이스 비밀번호 */
MYSQL_PASSWORD?: string;

/** MySQL 데이터베이스 사용자 이름 */
MYSQL_USER?: string;

// RDS MODE에서
/** RDS 데이터베이스 이름 */
RDS_DB_NAME?: string;
/** RDS 데이터베이스 주소 */
RDS_HOSTNAME?: string;
/** RDS 데이터베이스 비밀번호 */
RDS_PASSWORD?: string;
/** RDS 데이터베이스 사용자 이름 */
RDS_USERNAME?: string;
}
}
}