From 71dfe8009347ecbf8118b1a66bd04e2ddf8bbc1e Mon Sep 17 00:00:00 2001 From: eGovFrameSupport Date: Fri, 31 Mar 2023 15:01:07 +0900 Subject: [PATCH] Doc: update README.md --- README.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index cbd6e53..80ea87c 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,54 @@ # 표준프레임워크 심플홈페이지 BackEnd -※ 본 프로젝트는 기존 JSP 뷰 방식에서 벗어나 BackEnd와 FrontEnd를 분리하기 위한 예시 파일로 참고만 하시길 바랍니다. +![java](https://img.shields.io/badge/java-007396?style=for-the-badge&logo=JAVA&logoColor=white) +![Spring_boot](https://img.shields.io/badge/Spring_Boot-F2F4F9?style=for-the-badge&logo=spring-boot) +![maven](https://img.shields.io/badge/Maven-C71A36?style=for-the-badge&logo=apache-maven&logoColor=white) +![swagger](https://img.shields.io/badge/swagger-85EA2D?style=for-the-badge&logo=swagger&logoColor=black) +※ 본 프로젝트는 기존 JSP 뷰 방식에서 벗어나 BackEnd와 FrontEnd를 분리하기 위한 예시 파일로 참고만 하시길 바랍니다. ## 환경 설정 + 프로젝트에서 사용된 환경 프로그램 정보는 다음과 같다. | 프로그램 명 | 버전 명 | | :--------- | :------ | -| java | 1.8 | -| maven | 3.8.4 | - - +| java | 1.8 이상 | +| maven | 3.8.4 | ## BackEnd 구동 ### CLI 구동 방법 + ```bash mvn spring-boot:run ``` + ### IDE 구동 방법 + 개발환경에서 프로젝트 우클릭 > Run As > Spring Boot App을 통해 구동한다. +### 구동 후 확인 +구동 후, 브라우저에서 `http://localhost:포트번호/` 로 확인이 가능하다. +초기 포트번호는 8080이며 `/src/main/resources/application.properties` 파일의 `server.port` 항목에서 변경 가능하다. +또한, `http://localhost:포트번호/swagger-ui/index.html#/` 로 애플리케이션의 엔드포인트를 확인 가능하다. ## FrontEnd 구동 (React) 현재 FrontEnd는 React 관련 예제로 구성되어 있다. [심플홈페이지FrontEnd](https://github.com/eGovFramework/egovframe-template-simple-react.git) 소스를 받아 구동한다. - - ## 변경 사항 -### 1. [Java Config 변환](./Docs/java-config-convert.md) - -#### 1) Web.xml -> WebApplicationInitializer 구현체로 변환 - +### 1. [Java Config 변환](./Docs/java-config-convert.md) -#### 2) context-*.xml -> @Configuration 변환 +#### 1) Web.xml -> WebApplicationInitializer 구현체로 변환 +#### 2) context-\*.xml -> @Configuration 변환 #### 3) properties 변환(예정) boot 지원 - ### 2. API 변환 + 직접 View와 연결하던 방법에서 API 형식으로 변환 -> 다양한 프론트에서 적용 가능 하도록 예제 제공\ ※ API를 사용한 Controller들은 ~ApiController.java에서 확인 가능합니다. -