[Django] 유저시스템 : 디장고 프로젝트 시작을 위한 pre setting 단계별 정리

🔍 디장고에 대한 기초적인 내용은 다른 포스팅을 참고!(글 제일 하단에 정리해두었습니다)

django.contrib.auth, django-allauth에 대한 내용은 추후 포스팅 예정 :)

---

1️⃣사전 준비

1. 폴더 만들기

• mkdir {폴더 이름}
• example) mkdir django-coplate
• 디장고 프로젝트를 만들 공간

2. 가상환경 만들기

• pyenv virtualenv {파이썬 버전} {가상환경 이름}
• example) pyenv virtualenv 3.9.10 django_coplate_env
• 생성 후 설치된 python 버전 및 환경 확인 : pyenv versions

3. 가상환경 지정

• 1에서 만들어준 폴더로 이동 후 명령어 입력
• pyenv local {가상환경 이름}
• pyenv local django_coplate_env

4. 디장고 설치

• pip install django==2.2

5. 프로젝트 정의

• django-admin startproject {프로젝트 이름}
• django-admin startproject coplate_project

6. 앱 생성

• python manage.py startapp {생성할 App 이름}
• python manage.py startapp coplate
• 프로젝트 디렉토리의 settings.py 파일의 INSTALLED_APPS 리스트에 생성한 앱 추가

---

2️⃣ 유저 모델 정의하기

1. 앱 디렉토리의 models.py에 유저 모델 정의

# models.py
from django.db import models
from django.contrib.auth.models import AbstractUser  # 유저 모델

# Create your models here.
class User(AbstractUser):
    pass

 

2. 프로젝트 디렉토리의 settings.py 파일에 아래 코드 추가 : 해당 프로젝트 내에서 유저 모델로 해당 모델을 사용하겠다고 알려주는 의미

## settings.py 파일 맨 아래에 추가
# 유저 모델로 해당 모델을 사용하겠다는 의미 
# AUTH_USER_MODEL = '{앱 이름}.User'
AUTH_USER_MODEL = 'coplate.User'

 

3. 마이그레이션 후 저장(매우 중요)

## 터미널 : 마이그레이션 생성
python manage.py makemigrations
python manage.py migrate

---

3️⃣ 유저 모델 admin 페이지 등록 & superuser 생성

1. 유저모델 admin에 등록 : 유저모델의 특이사항으로, UserAdmin을 같이 인자로 주어 등록해야함

from django.contrib import admin
from django.contrib.auth.admin import UserAdmin
from .models import User

# Register your models here.
# 모델을 가져와서 인자로 넣어준다
admin.site.register(User, UserAdmin)

 

2. superuser(관리자 계정) 생성

## 터미널
python manage.py createsuperuser

 

createsuperuser!

---

4️⃣ allauth set up

아래 레퍼런스에도 기입해두었지만, django-allauthInstallation doumentation에서 매우 친절하게 설명해주고 있으니 참고! 

 

1. 터미널에서 패키지 설치

## 터미널
pip install django-allauth

 

2. settings.py 파일 수정

🔍 INSTALLED_APPS 순서 : 에러가 나는 것은 아니지만 아래의 순서가 관례이다(convention)

1. Local apps : 내가 생성한 앱
2. Third party apps : 외부에서 끌어온 앱
3. Django apps : 디장고 내부적으로 제공하는 앱

🔍 'django.contrib.sites' : 어떤 기능을 여러 웹사이트에서 사용하게 해준다

• 비슷한 컨텐츠나 기능을 가지고 있는 웹사이트가 여러개 필요할 때 활용하여 프로젝트 하나로 여러 웹사이트 운영 가능
• 여기서 SITE_ID가 각각의 웹사이트의 아이디

🔍 EAMIL_BACKEND

• allauth가 제공하는 이메일 인증이나 비밀번호 찾기 기능을 활용하려면 이메일을 보낼 수 있어야하는데
• 이 때, 이메일을 어떻게 보낼지 설정하는 코드임

 

## settings.py
# 1)유저인증 로직을 담당하는 컴포넌트들 추가
AUTHENTICATION_BACKENDS = [
    # Needed to login by username in Django admin, regardless of `allauth`
    'django.contrib.auth.backends.ModelBackend',

    # `allauth` specific authentication methods, such as login by e-mail
    'allauth.account.auth_backends.AuthenticationBackend',
]


# 2)필요한 앱 복사해서 추가
INSTALLED_APPS = [
	# 1. Local apps(내가 생성한 앱)
    '{app}'
    
    # 2. Third party apps(끌어온 앱)
    'django.contrib.sites',
    'allauth',
    'allauth.account',
    'allauth.socialaccount',
    
    # 3. Django apps(디장고 기본 앱)
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]


# 3) 아래 내용 정의
SITE_ID = 1

# Email settings
EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"


## 프로젝트 디렉토리의 urls.py에 아래 내용 추가
path('', include('allauth.urls'))

---

5️⃣ 확인

디장고 개발 서버를 실행하고http://0.0.0.0:8000/login/, http://0.0.0.0:8000/admin/ 으로 접속하면 잘 접속된다!

## 터미널
python manage.py runserver 0.0.0.0:8000

1. 로그인 페이지 : http://0.0.0.0:8000/login/

 

login 페이지

2. 관리자 페이지 : http://0.0.0.0:8000/admin/

아까 만든 superuser 계정으로 로그인하면 된다. GUI로 편하게 관리할 수 있다:)

admin 페이지(로그인 전)

 

admin 페이지(로그인 후)

---

🙏 Reference

• codeit :Django 웹 개발 시작하기
• django-allauth Installation doumentation
• [Django & 가상환경] pyenv 명령어 모음 및 개념 정리 (내 블로그)
• [Django] Project와 App 구조 & Reusable App (내 블로그)