Django project Initial settings

django | June 15, 2020

Django project를 처음 시작할 때 고려해야 하는 사항들이 있다.
django-admin startproject 명령어로 프로젝트를 시작한 후, 아래의 내용들을 다 처리한 후에 git에 push 하면 초기세팅 완료!

1) .gitignore

기본적으로 git에 올리게 되면, 모든 소스코드가 공유된다.
그러나 올리고 싶지 않은 것이나 올려서는 안 되는 정보들이 있다.
그런 파일이나 폴더 등이 git에 올라가지 않도록 .gitignore 파일을 생성해서 관리해야 한다.

이미 git에 push해서 올라와 있다면, 나중에 ignore를 해도 git repo에서 자동으로 없어지지 않는다.
물론 방법이 있겠지만, git rm 명령어로 하나씩 지워줘야 하는 번거로움이 있다.
때문에 처음에 정리해서 git ignore 해놓아야 한다. 프로젝트 시작하면 무조건 제일 먼저 해야하는 초기세팅 단계!!

장고 프로젝트 최상위 폴더에 .gitignore파일을 생성한다.
django-admin startproject 명령어로 project를 생성했다면, manage.py 파일이 있는 가장 상위 폴더에 ignore 파일을 만들면 된다.

vi .gitignore

gitignore 앞에 .이 붙었기 때문에 숨김 파일로 생성된다.

이제, .gitignore는 생성하긴 했는데, 뭘 git에 올리지 말아야 하는지를 모른다.
그걸 알려주는 좋은 사이트 하나가 있다.

.gitignore 자동생성기

➡ .gitignore 파일에 정의할 요소를 알려주는 사이트 바로가기

위의 링크에서 기본적으로 vim, linux, django, python을 입력해주고, create를 하면 페이지가 하나 뜬다.
(위의 예시들 말고 다른 키워드를 입력하거나 추가해도 그에 맞게 요소들을 알려준다.)
이걸 전체 복사해서 생성한 .gitignore에 붙여넣기 하면 끝!

그리고 3)에서 만들 my_settings.py도 git ignore 처리 해줘야 한다.

2) cors-headers

cors-headers를 설정해주지 않으면, frontend와 연결되지 않아 front에서 아무리 요청해도 우리는 요청을 받을 수 없다.
frontend와의 connection을 위한 필수 설정!

1️⃣ cors에 대한 처리를 원활하게 도와줄 플러그인 django-cors-headers를 설치한다.
```
pip install django-cors-headers
```

2️⃣ settings.py의 INSTALLED_APPS 추가

INSTALLED_APPS = [
...
  'django.contrib.staticfiles',
	  'corsheaders'
]

3️⃣ settings.py의 MIDDLEWARE 추가

MIDDLEWARE = [
...
  'corsheaders.middleware.CorsMiddleware',
...
]

4️⃣ settings.py의 제일 마지막에 관련 code 추가

##CORS
CORS_ORIGIN_ALLOW_ALL=True
CORS_ALLOW_CREDENTIALS = True

CORS_ALLOW_METHODS = (
  'DELETE',
  'GET',
  'OPTIONS',
  'PATCH',
  'POST',
  'PUT',
)

CORS_ALLOW_HEADERS = (
  'accept',
  'accept-encoding',
  'authorization',
  'content-type',
  'dnt',
  'origin',
  'user-agent',
  'x-csrftoken',
  'x-requested-with',
)

3) my_settings

Database나 Secret key와 같은 정보는 git에 올라가면 안 되는, secret하게 관리되어야 하는 정보다.
그래서 settings.py에 그 정보를 바로 넣는 것이 아니라 별도의 파일로 관리해야 한다.

startproject를 했다면, 가장 상위의 폴더에 들어가서 my_settings.py를 생성한다. (manage.py와 같은 레벨인 폴더에서 생성)
```
django-admin startproject '하고싶은 프로젝트 명'
cd '생성한 프로젝트 폴더명'
touch my_settings.py
```

my_settings.py 안에 쓰여지는 내용의 예시
이 외에도, git에 올리고 싶지 않은 config 내용, 외부 API(SNS 로그인, AWS 접속용 정보)도 기록할 수 있다.

DATABASES = {
  'default' : {
      'ENGINE': 'django.db.backends.mysql',
      'NAME': 'DATABASE 명',
      'USER': 'DB접속 계정명', #주로 'root'
      'PASSWORD': 'DB접속용 비밀번호',
      'HOST': '실제 DB 주소',
      'PORT': '포트번호',
  }
}

SECRET = {
      'secret':'시크릿키',
}

이 내용을 settings.py에 적용하려면, 아래와 같은 방식으로 적용할 수 있다.
```
import my_settings

DATABASE = my_settings.DATABASES
SECRET_KEY = my_settings.SECRET
```

my_settings.py를 만들고 가장 중요한 것은, .gitignore에 추가하는 것!
파일 이름만 한 줄 추가해주면 된다.
```
### personal ###
my_settings.py
```

4) commentary (주석처리)

django에서 사용하지 않을 front(template) 기능이나, admin, auth 기능 등의 코드는 settings.py에서 주석처리를 해줘야 한다.
자세한 주석처리 방법은 ➡ settings.py에서 주석처리 할 것들

5) requirements.txt

가상환경에서 설치해놓은 module을 볼 수 있는 명령어
```
pip freeze
```

협업을 할 때에는 개발환경을 공유해야 하는데, 필요한 모듈 리스트를 파일로 git에 올릴 수 있다.
아래의 명령어를 입력하면, requirements.txt 파일에 내 가상환경에 설치된 모듈 리스트가 저장된다.
생성된 requirements.txt 파일을 그대로 git에 올리면 끝.
```
pip freeze > requirements.txt
```

requirements.txt 파일에 있는 모듈들을 내 가상환경에 한꺼번에 설치도 가능하다.
```
pip install -r requirements.txt
```

6) README.md

github repo에서 readme는 굉장히 중요하다. 원래 요약이 제일 중요하고 어렵지..
해당 repo가 어떤 프로젝트인지를 readme만 보고 쉽게 이해할 수 있도록 작성하는 게 중요하다.
개인적으로 readme를 잘 작성했을 때 뿌듯함을 느끼는 편 ☺
나중에 readme를 다 적으려면 막막하기도 해서 미리 만들어놓고 조금씩 수정해가는 것도 좋은 방법인 것 같다.

파일명을 README.md로 만들어서 깃에 다른 파일들과 같이 push 해도 되고, github repo에서 직접 생성하고 수정해도 된다.
개인적으로는 repository에서 직접 생성하는 게 편한데, markdown으로 적은 readme 파일이 실제로 어떻게 보여지는지 preview 기능으로 확인 가능하기 때문!

Hello, I'm@hongdev

🍓Github