2024년 하반기 인하대학교 컴퓨터공학 종합설계 (1조) 프로젝트

Initial written at September 05, 2024
last updated at: September 10, 2024

Current: ver. 1.0.0

• ver 1.0.0.
  • Init: 프로젝트 세팅 ( React + Spring Boot )

1. 프로그램 (프로젝트) 설명

• 본 프로젝트는 2024년 하반기 인하대학교 컴퓨터공학 종합설계 (1조) 프로젝트입니다
• 기간 : 2024.09.04 ~ 2024.12.17
• 인원 : 4인 ( 12171689 장승범, 12181639 윤준혁, 12181683 정재현, 12201836 이영주 )
• 본 프로젝트의 운영체제는 Linux OS를 기반으로 작성되었습니다.

2. Prerequisite

• 본 프로젝트는 Docker를 사용하므로 .env.template 파일을 참고하여 .env 파일에 환경 변수값을 작성해주세요.
  • HOST_PORT : 외부에서 컨테이너의 애플리케이션에 접근하는데 사용하는 포트 ( 노출되도 괜찮은 포트 )
  • SERVER_PORT : 애플리케이션이 컨테이너 내에서 통신하는 포트 ( 노출되면 안되는 포트 )
  • React에서는 보안이 필요한 환경변수의 유출을 막기 위해서 REACT_APP_으로 시작하지 않는 환경변수는 무시되기 때문에 REACT_APP_SPRINGBOOT_HOST_PORT가 필요합니다.

  # 예시
  REACT_HOST_PORT=3001
  REACT_SERVER_PORT=3000
  
  SPRINGBOOT_HOST_PORT=8081
  SPRINGBOOT_SERVER_PORT=8080
  
  REACT_APP_SPRINGBOOT_HOST_PORT=8081
  

• 본 프로젝트는 Spring Boot 프로젝트가 포함되어 있으므로 application.properties.template 파일을 참고하여 application.properties 파일을 작성해주세요
  • 이때 SPRINGBOOT_SERVER_PORT와 springboot-servie/src/main/resources/application.properties 파일의 server.port를 일치시켜 주세요

  # 예시
  spring.application.name=springboot-app
  server.port=8080
  

3. 구동 방법

3.1. 프로젝트 실행

본 프로젝트는 Docker Compose를 사용하므로 이를 실행시켜주세요.

(sudo) docker compose up (--build)

3.2 프로젝트 종료

본 프로젝트는 Docker Compose를 사용하므로 이를 실행시켜주세요.

(sudo) docker compose down (-v)

4. 디렉토리 및 파일 설명

    /project-root
    ├── react-app/
    │   ├── public/
    │   │   ├── favicon.ico
    │   │   ├── index.html
    │   │   ├── logo192.png
    │   │   ├── logo512.png
    │   │   ├── manifest.json
    │   │   └── robots.txt
    │   ├── src/
    │   │   ├── App.css
    │   │   ├── App.js
    │   │   ├── App.test.js
    │   │   ├── index.css
    │   │   ├── index.js
    │   │   ├── logo.svg
    │   │   ├── reportWebVitals.js
    │   │   └── setupTests.js
    │   │
    │   ├── .gitignore
    │   ├── dockerfile
    │   ├── entrypoint.sh
    │   ├── package-lock.json
    │   ├── package.json
    │   └── README.md
    │
    ├── springboot-app/
    │   ├── gradle/
    │   │   └── wrapper/
    │   │       ├── gradle-wrapper.jar
    │   │       └── gradle-wrapper.properties
    │   ├── src/
    │   │   ├── main/
    │   │   │   ├── java/com/inha/springbootapp/
    │   │   │   │   └── springbootAppApplication.java
    │   │   │   └── resources/
    │   │   │       ├── application.properties
    │   │   │       └── application.properties.template
    │   │   └── test/
    │   │       └── java/com/inha/springbootapp/
    │   │           └── springbootAppApplicationTest.java
    │   │
    │   ├── .gitignore
    │   ├── build.gradle
    │   ├── dockerfile
    │   ├── entrypoint.sh
    │   ├── gradlew
    │   ├── gradlew.bat
    │   └── settings.gradle
    │
    ├── .env
    ├── .env.template
    ├── .gitattributes
    ├── .gitignore
    ├── docker-compose.yml
    └── README.md