be-ddokddak

• dodonenow 백엔드 서버 저장소입니다.

서버 구성

ERD

프로젝트 구조

• 레이어드 아키텍쳐 기반 프로젝트이며, 디렉토리 구조는 도메인형으로 구성되어 있습니다.

└─src
    ├─docs
    │  └─asciidoc
    ├─main
    │  ├─java
    │  │  └─com
    │  │      └─ddokddak
    │  │          ├─activityRecord
    │  │          │  ├─api
    │  │          │  ├─dto
    │  │          │  ├─entity
    │  │          │  ├─mapper
    │  │          │  ├─repository
    │  │          │  └─service
    │  │          ├─auth
    │  │          │  ├─api
    │  │          │  ├─batch
    │  │          │  ├─domain
    │  │          │  │  └─oauth
    │  │          │  ├─entity
    │  │          │  ├─enums
    │  │          │  ├─filter
    │  │          │  ├─handler
    │  │          │  ├─repository
    │  │          │  └─service
    │  │          ├─category : 유저의 활동을 분류하는 카테고리 관련
    │  │          │  ├─api
    │  │          │  ├─dto
    │  │          │  ├─entity
    │  │          │  ├─enums
    │  │          │  ├─mapper
    │  │          │  ├─repository
    │  │          │  └─service
    │  │          ├─common : 프로젝트에서 공통으로 사용하는 기능 관련
    │  │          │  ├─config
    │  │          │  ├─dto
    │  │          │  ├─entity
    │  │          │  ├─exception
    │  │          │  │  └─type
    │  │          │  ├─filter
    │  │          │  ├─props
    │  │          │  ├─repository
    │  │          │  └─utils
    │  │          ├─member : 서비스를 가입한 유저 관련
    │  │          │  ├─api
    │  │          │  ├─dto
    │  │          │  ├─entity
    │  │          │  │  └─enums
    │  │          │  ├─mapper
    │  │          │  ├─repository
    │  │          │  └─service
    │  │          └─usecase
    │  └─resources
    │      ├─mail-templates
    │      └─static
    │          └─docs
    └─test
        └─java
            └─com
                └─ddokddak
                    ├─activityRecord
                    │  ├─api
                    │  ├─fixture
                    │  └─service
                    ├─auth
                    │  └─service
                    ├─category
                    │  ├─api
                    │  ├─fixture
                    │  └─service
                    ├─member
                    │  └─api
                    ├─usecase
                    └─utils
                        └─security
├─build
├─config
├─gradle
└─logs

로컬 실행 방법

docker-compose -f ./docker-compose-local.yml up -d

• 도커 허브 퍼블릭 레포를 활용합니다.
  • 도커 허브 로그인은 push 하는 경우 필요합니다. (계정 정보는 노션 확인)
  • docker-compose-local.yml 파일을 적절한 경로에 내려받아서 위 명령어를 수행합니다.
• 로컬의 8080 포트와 3307 포트가 활용 중이라면, 충돌이 발생할 수 있습니다.
• db 클라이언트 서비스(디비버 등)로 도커의 디비 컨테이너에 접속할 때는 localhost:3307 주소 (계정 root / 비번 1234)를 활용할 수 있습니다.
  • db 관련 데이터는 mysqldata 라는 디렉토리를 생성하여 저장되게 됩니다.

swagger 링크 주소

http://localhost:8080/swagger-ui/index.html

• 로컬에서 프로젝트를 실행했을 때, 위 주소로 접속하여 api를 간단히 테스트할 수 있습니다.

rest-docs 링크 주소

http://localhost:8080/docs/index.html

• 로컬에서 프로젝트를 실행했을 때, 위 주소로 접속하여 rest-docs를 활용해 제작된 api 문서를 확인할 수 있습니다.
• 문서의 html 파일 경로
  • 위 디렉토리 이하에서 html 파일을 확인해보실 수도 있습니다.