Visual Studio Code에서 Django 프로젝트 기본 셋팅 하는 법(파일 생성부터 Git 설정까지)

Frel·2022년 6월 21일
3

내일 배움 캠프

목록 보기
34/35
post-thumbnail
post-custom-banner

이번에 Django 프로젝트들을 하면서 느낀점들은 처음에 셋팅하는 부분에서 헷갈리는게 많아, 시간을 너무 잡아 먹었던 것 같습니다. 처음으로 Visual Studio Code로 이번에 넘어오게 되어서, Django 프로젝트를 할때 필요한 기본 셋팅에 대해 알아보겠습니다. (윈도우 기준으로 작성되었습니다.)


1. 프로젝트 폴더 만들기

우선 프로젝트를 진행할 폴더를 만들어 줍니다.

바탕화면에서 바탕화면을 우클릭하고 새로 만들기 -> 폴더를 클릭해서 새 폴더를 만들어 줍니다.

새 폴더를 만드셨다면, 이미지처럼 앞으로 진행할 프로젝트의 이름을 적어줍니다.


2. Vscode로 폴더 열기

그러면 이제 Vscode를 실행시켜 주시고, Vscode로 만든 폴더를 열어보겠습니다.

Vscode를 실행 시키시면 이미지와 같은 화면이 뜹니다.
여기서 왼쪽 상단에 있는 파일을 눌러 줍니다.


파일을 누르시면 이렇게 설정들이 나올텐데, 여기서 폴더 열기를 눌러줍니다.

그리고 아까전에 만든 프로젝트 파일을 선택해서 열어 주시면 됩니다.

제대로 열어주셨다면 왼쪽 상단 탐색기라고 써진 부분 아래에 만들었던 프로젝트의 이름이 보이시는 걸 확인 할 수 있습니다. 그러면 제대로 성공하신 겁니다.


3. Django, Python 확장 설치

Vscode화면에서 오른쪽 아이콘 부분에서 "확장"을 눌러줍니다.

확장을 누르시면 이렇게 화면이 뜨고, 먼저 검색창에 Django를 입력해줍니다.

입력한 후 맨 위에있는 Django를 눌러서 화면과 같은 버전을 설치 해줍니다.
(저는 이미 설치를 해둔 상태입니다.)

Django를 설치 하셨다면 검색창에 Python을 검색해 줍니다.

Python도 Django 설치할때와 같이 똑같이 해주시면 끝입니다!


4. 가상환경 설치

우선 현재 상태에서 Ctrl + ` 을 눌러서 터미널 창을 열어줍니다.
터미널 창을 열었다면 위의 이미지처럼 나옵니다.

python -m venv venv

위에 코드를 터미널에 입력하면 python 자체적으로 가지고 있는 가상환경을 설치해줍니다.

제대로 설치가 되었다면 해당 이미지처럼 나오게 됩니다.


5. 가상환경 실행

이제 가상환경을 실행 시켜보도록 하겠습니다. 터미널에 아래의 코드를 입력합니다.

[Windows 기준]

venv/Scripts/activate

[Mac 기준]

venv/bin/activate

이미지처럼 터미널 옆에 (venv)이렇게 생기게 된다면 가상환경이 성공적으로 실행 된 것 입니다.

제대로 실행이 안되신다면 코드들 앞에 source를 적어주시면 됩니다!
예시) source venv/Scripts/activate

가상환경을 나가고 싶을때는 아래 코드를 적어주시면 됩니다.

deactivate

이미지를 보시면 위의 코드를 입력한 후 (venv)가 사라진 모습 입니다.


6. 패키지 설치

패키지를 설치할때는 꼭 가상환경을 실행시킨 후에 진행해주세요!

터미널 창을 열어주시고 아래의 코드를 입력해줍니다.

pip install django

가상환경에 Django 패키지를 설치한 것 입니다.

이제 DRF를 설치 해보겠습니다. 아래 코드를 터미널 창에 입력해주세요.

pip install djangorestframework

아래 이미지 처럼 나오면 설치 완료입니다!


7. gitignore 설정

gitignore 설정을 해보겠습니다. gitignore 설정을 하게되면 git에 올릴때 자동으로 올라가지 않도록 설정 할 수 있습니다.

[gitignore.io 주소]

https://www.toptal.com/developers/gitignore/

주소에 접속하시면 이미지의 화면이 보이는데 검색창에 자신이 사용하는
운영체제/개발 환영/프로그래밍 언어들을 적어주시고 생성을 눌러 줍니다.

생성 버튼을 누르시면 이렇게 화면이 나오는데
Ctrl + A를 해서 전체선택을 하고
Ctrl + C를 해서 복사 해줍니다.

그 후 다시 VScode로 돌아가서 venv 아래쪽에 있는 빈칸을 우클릭 해서 새 파일을 만들어 줍니다. 이름은 .gitignore로 만들어 줍니다.

이미지와 같이 만들어지면 성공입니다. 그리고 .gitignore에 들어가서 아까 복사해온 부분들을
Ctrl + V를 해서 붙여넣기를 해줍니다.

그리고 12번째줄에 있는 media 아래에다가 venv를 입력해주고 저장해줍니다.
Ctrl + C를 해서 저장을 할 수 있습니다.

venv를 적고 저장까지 하고나면 이제 git에 업로드 할때 venv 파일을 업로드 되지 않습니다.
저 부분에다가 파일 이름을 적어주면 그 파일은 업로드 되지 않습니다.


8. Github repository 생성

이제 Git에 업로드 하기 위해서 repository를 만들어 보겠습니다.

자신의 Github의 계정으로 로그인 한 후 이미지 화면의 New 버튼을 눌러줍니다.

이름을 정하고 아래에 있는 Create repository를 눌러줘서 repository를 생성해 줍니다.

이미지의 화면이 나오면 성공적으로 만드신겁니다!


9. 설치 패키지 관리

gitignore를 사용할때는 꼭 해줘야하는 부분이 있습니다.

pip freeze > requirements.txt

코드를 적어주면 이미지처럼 txt파일이 생기고 안에는 설치한 패키지들이 있습니다.
새로운 패키지을 추가할때마다 해당 코드를 입력해줘야 합니다.

이 파일을 업로드 하면 설치한 패키지들을 편하게 관리 할 수 있고, 다른 사람이 이 파일을 클론을 받아서 사용할때

pip install -r requirements.txt

위의 코드를 입력해주면 제가 설치했던 패키지들을 한번에 다운받을 수 있습니다.


10. VScode 터미널로 git 연동

VScode에 있는 터미널로 git과 연동 해보겠습니다.

git init

해당 코드를 적으면 git을 시작합니다.

git remote add origin [Github repository 주소]

repository의 주소를 넣어줘서 앞으로 push 할 repository와 연결합니다.

git add .

현재 있는 파일들을 생성 해줍니다.

git commit -m '설명'

업로드할 파일의 설명을 적어줍니다.

git branch -M main

메인 브랜치의 이름을 설정합니다.

git push origin main

repository에 모든 파일들이 올라갑니다.

이미지처럼 뜬다면 성공적으로 파일 업로드에 성공한 것입니다!


다음 내용으로는 Django 기본 셋팅을 알아보겠습니다! 긴 글 읽어주셔서 감사합니다.

profile
자기개발을 해서 발전하는 미래의 개발자
post-custom-banner

0개의 댓글