2024 한이음 AEYE 프로젝트

AEYE WEB BackEnd 서버 리포지토리 입니다.
AWS EC2 인스턴스 안에서 빠르게 환경설정을 할 수 있도록 쉘을 작성하였습니다.

| 작성된 쉘을 통해 자동으로 도커를 설치하고 도커 컨테이너 안에서 Next.js와 Django를 하나의 AWS EC2 인스턴스 안에서 쉽게 실행할 수 있습니다.

브랜치 구성은 다음과 같이 구성되어 있습니다.

main    : 프로젝트 테스트까지고 끝난 완성된 버전
test    : 코드 작성이 끝나고 테스트 중인 버전
develop : 코드 작성중인 버전 

test 브랜치에서는 Github Actions를 통해 CI가 진행되어 작성된 코드가 정의된 테스트 기준에 충족하는지 평가합니다. pytest 프레임워크를 통해 pytest 플더에 정의된 테스트 기준에 충족하는지 평가합니다.

서버 환경

Python : 3.6
Django : 3.2
djangorestframework : 3.13.1

Python 버전은 AI 서버가 요구하는 Tensorflow 버전이 파이선 3.6에서 동작이 가능하여 일관성을 위해 AEYE 프로젝트의 모든 Python 버전을 3.6으로 통일시켰습니다. Django 3.2는 파이선 3.6에서 동작 가능한 Django 버전이어서 Django 3.2 버전을 사용했습니다.

서버 디렉토리 구성

.
├── AEYE_Back_3_2/   # AEYE WEB Django 서버
│   ├── AEYE_Back_3_2/
│   │   ├── __init__.py
│   │   ├── __pycache__/
│   │   ├── asgi.py
│   │   ├── settings.py
│   │   ├── urls.py
│   │   └── wsgi.py
│   ├── data/    # AEYE API 정의
│   │   ├── __init__.py
│   │   ├── __pycache__/
│   │   ├── admin.py
│   │   ├── apps.py
│   │   ├── migrations/
│   │   ├── models.py
│   │   ├── serializers.py
│   │   ├── signals.py
│   │   ├── tests/   # AEYE 테스트 케이스 정의
│   │   │   ├── __init__.py
│   │   │   └── test_api.py
│   │   ├── tests.py
│   │   ├── urls.py
│   │   └── views.py
│   ├── db.sqlite3
│   ├── manage.py
│   └── pytest.ini
├── AEYE_Front/   # AEYE WEB Front
├── Docker/   # Docker 파일
│   ├── Django/   # Back-End를 위한 도커 파일
│   │   └── Dockerfile
│   ├── Next_js/   # Fron-End를 위한 도커 파일
│   │   └── Dockerfile
│   ├── MySQL/   # DataBase를 위한 도커 파일
│   │   └── Dockerfile
│   └── docker-complose.yml
├── LICENSE
├── README.md
├── install.sh   # AEYE WEB Package 설치
├── appspec.yml
├── dependencies.txt   # pip 설치를 위한 공통 dependencies
├── dependencies_web_Back.txt   # pip 설치를 위한 Back dependencies
└── dependencies_web_Front.txt   # pip 설치를 위한 Front dependencies

프로젝트 패키지 실행

아래는 Linux 환경에서 AEYE 프로젝트를 시작하는 명령어 입니다.

./install.sh

Shell을 시작하면 AEYE 웹 서버를 시작하기 위해 필요한 dependencies를 설치하고, Docker를 설치한 후, 본 프로젝트에서 정의한 Docker Compose를 통해 서버를 시작합니다.

REST API EndPoint

아래는 AEYE 웹 벡엔드 서버에서 제공하는 REST API EndPoint 입니다. HTTP POST 요청을 할 경우, 다음 주소를 이용하면 됩니다.

https://127.0.0.1:8000/api/data/front/ 

JSON 데이터 형식

아래는 Front-End에서 Back-End 서버로 보내야 하는 JSON 데이터의 예제입니다. name 은 CharField 이며, date 는 DateField 입니다.

{
  "name": "John Doe",
  "date": "2024-07-28"
}

Port 구성

아래는 AEYE Web 프로젝트에서 사용하는 포트를 정의했습니다.

Django : 8000
Next.js : 80
MySQL : 3306

AWS 환경

인스턴스 유형 : t2.micro
AMI : ubuntu-20.04 (ami-0cc095efd4953d3fc )