.gitignore .env dotenv 환경변수 설정 및 관리

coding/git

JIN_Coder 2022. 8. 6. 01:53

.gitignore이란?

git으로 관리하지 않을 파일들을 설정해 주는 파일이므로 이 안에 있는 파일들을 gitHub에 업로드되지 않는다.

// .gitignore

# 파일 무시
test.txt

# 다음과 같은 확장자는 전체 무시
*.text
*.exe
*.zip

# 폴더 무시
test/

gitignore 안에 작성한 파일 및 폴더는 변경사항이 있더라도 변경사항에 포함되지 않아 git commit 을 해도 반영이 되지 않는다. 당연히 push에도 영향을 받지 않는다.

.env이란

환경변수를 설정한 파일

남들에게 보여서는 안 되는 정보들이 담겨있기에 이 파일이 깃 허브에 올라가 모두에게 중요한 정보를 노출되지 않도록 .gitignore 파일에 명시한다.

주로 ID, PW, secretkey 등등 중요한 정보를 작성한다.

변수명 = 정보

dotenv란?

환경 변수를 지정할 수 있는 .env 파일을 생성하고 환경변수를 관리할 수 있는 라이브러리이다.

사용방법

1. 설치

npm install dotenv

2. .env 파일 생성

3. .env 파일 안 코드 작성

변수는 모두 대문자를 사용하는게 일반적이라고 한다.

// .env 파일

port = 3000
ID = jin
PW = 1234

4. 환경변수 사용할 파일에 dotenv require

// app.js

require("dotenv").config();

5. .env 환경변수 사용하기 process.env.변수명

// app.js

require("dotenv").config();
const port = process.env.port;
const id = process.env.ID;

다른 곳에서 사용하는 법

그런 건 없는 것 같다...

중요한 정보다 보니 깃허브에 공개를 하지 않아 다른 컴퓨터에서 git clone을 해도 해당 파일들 없이 파일을 복제한다.

그렇다 보니 필요한 파일이 없기 때문에 직접 만들어주거나 개인적인 방법을 사용해서 파일을 가져와 사용해야 정상적인 코드가 작동할 것이다.

~~매니저님들에게 더 좋은 방법이 있는지 물어보기~~

정리

항상 중요한 정보는 .env 파일을 만들어 변수 = 정보 로 저장을 하고

dotenv 를 설치한 후

필요한 파일에서 require("dotenv").config() 로 사용 가능하게 해 주고

사용할 정보는 const port = process.env.port 식으로 사용한다.

마지막으로 .gitignore 에 .env ,node_modules , config 등을 명시해주어 변경사항이 있어도 적용 안되게 해 주고
git commit push로 깃허브에 올린다.

사용할때는 파일이 없으니까 직접 만들거나 가져와야 한다.

JIN_CODER