From 998c894351f42502b3ee513e3730acb5dc7ee466 Mon Sep 17 00:00:00 2001 From: junhyun1001 <90903322+junhyun1001@users.noreply.github.com> Date: Fri, 5 Dec 2025 18:14:26 +0900 Subject: [PATCH] Updated README --- README.md | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 71 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index de90fb0..57e1050 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,73 @@ -[![Build](https://github.com/FOR-GRAD/For-Grad-Server/actions/workflows/build.yml/badge.svg)](https://github.com/FOR-GRAD/For-Grad-Server/actions/workflows/build.yml) -[![Deploy](https://github.com/FOR-GRAD/For-Grad-Server/actions/workflows/deploy.yml/badge.svg)](https://github.com/FOR-GRAD/For-Grad-Server/actions/workflows/deploy.yml) +# πŸŽ“ Forgrad (ν¬μ–΄κ·Έλž˜λ“œ) +> "λ³΅μž‘ν•œ μ‘Έμ—… μš”κ±΄, 더 이상 헀맀지 λ§ˆμ„Έμš”." +> λ°©λŒ€ν•œ 학사 정보 μ†μ—μ„œ 길을 μžƒμ€ λŒ€ν•™μƒλ“€μ„ μœ„ν•΄, 흩어진 정보λ₯Ό ν•œκ³³μ— λͺ¨μ•„ λ³΄μ—¬μ£ΌλŠ” λŒ€ν•™μƒ λ§žμΆ€ν˜• μ‘Έμ—… λ‘œλ“œλ§΅ μ„œλΉ„μŠ€μž…λ‹ˆλ‹€. -# For-Grad Spring Boot +
+
+ +
+ + + + + + + + + +
+ +
+ +## πŸ“– ν”„λ‘œμ νŠΈ μ†Œκ°œ (Introduction) + +ForgradλŠ” λ³΅μž‘ν•˜κ³  흩어져 μžˆλŠ” μ‘Έμ—… μš”κ±΄ 정보λ₯Ό ν•œκ³³μ— λͺ¨μ•„, λŒ€ν•™μƒλ“€μ΄ 효율적이고 κ³„νšμ μΈ ν•™κ΅μƒν™œμ„ ν•  수 μžˆλ„λ‘ λ•λŠ” μ‘Έμ—… 관리 및 학사 정보 ν”Œλž«νΌμž…λ‹ˆλ‹€. + +λ§Žμ€ 학생듀이 학ꡐ ν™ˆνŽ˜μ΄μ§€μ˜ λ°©λŒ€ν•œ 정보 μ†μ—μ„œ μžμ‹ μ—κ²Œ ν•„μš”ν•œ μ‘Έμ—… μš”κ±΄μ„ μ°ΎλŠ” 데 어렀움을 κ²ͺκ³  μžˆμŠ΅λ‹ˆλ‹€. ForgradλŠ” μ΄λŸ¬ν•œ μΌμƒμ˜ λΆˆνŽΈν•¨μ„ ν•΄μ†Œν•˜κ³ , μ‚¬μš©μžκ°€ 본인의 μ‘Έμ—… 진행 상황을 μ§κ΄€μ μœΌλ‘œ νŒŒμ•…ν•  수 μžˆλ„λ‘ μ‹œκ°ν™”λœ 정보λ₯Ό μ œκ³΅ν•©λ‹ˆλ‹€. + +
+ +## πŸ’‘ 기획 λ°°κ²½ (Background) + +λŒ€ν•™μƒλ“€μ—κ²Œ 'μ‘Έμ—…'은 κ°€μž₯ μ€‘μš”ν•œ λͺ©ν‘œ 쀑 ν•˜λ‚˜μ§€λ§Œ, μ •μž‘ 쑸업에 ν•„μš”ν•œ ꡬ체적인 μš”κ±΄μ΄λ‚˜ 남은 학점 등을 μ •ν™•νžˆ νŒŒμ•…ν•˜κ³  μžˆλŠ” 학생은 λ§Žμ§€ μ•ŠμŠ΅λ‹ˆλ‹€. + +1. μ •λ³΄μ˜ νŒŒνŽΈν™”: 학ꡐ ν™ˆνŽ˜μ΄μ§€ λ‚΄ 정보가 λ„ˆλ¬΄ λ°©λŒ€ν•˜κ³  μ—¬λŸ¬ 곳에 흩어져 μžˆμ–΄ 접근성이 λ–¨μ–΄μ§‘λ‹ˆλ‹€. +2. κ΄€λ¦¬μ˜ 어렀움: κ°œμΈλ³„λ‘œ μƒμ΄ν•œ μ‘Έμ—… μš”κ±΄(전곡, ν•™λ²ˆλ³„)을 슀슀둜 μ±™κΈ°κΈ°κ°€ 쉽지 μ•ŠμŠ΅λ‹ˆλ‹€. + +μš°λ¦¬λŠ” μ΄λŸ¬ν•œ 문제λ₯Ό ν•΄κ²°ν•˜κ³ μž "μ‚¬μš©μžλ“€μ˜ λΆˆνŽΈν•¨μ„ ν•΄μ†Œν•˜κ³  νŽΈμ˜μ— κΈ°μ—¬ν•˜λŠ” μ„œλΉ„μŠ€"λ₯Ό λͺ©ν‘œλ‘œ Forgradλ₯Ό κΈ°νšν•˜κ²Œ λ˜μ—ˆμŠ΅λ‹ˆλ‹€. + +
+ +## πŸ›  μ‹œμŠ€ν…œ μ•„ν‚€ν…μ²˜ (System Architecture) + +1. CI/CD νŒŒμ΄ν”„λΌμΈ +GitHub Actions와 Dockerλ₯Ό ν™œμš©ν•˜μ—¬ `PR Merge β†’ Build β†’ Docker Image Push β†’ EC2 Pull & Run`으둜 μ΄μ–΄μ§€λŠ” μžλ™ν™”λœ 배포 ν”„λ‘œμ„ΈμŠ€λ₯Ό κ΅¬μΆ•ν–ˆμŠ΅λ‹ˆλ‹€. + +2. μ„œλ²„ 인프라 (AWS) +- Compute: Amazon EC2 λ‚΄ Docker μ»¨ν…Œμ΄λ„ˆ ν™˜κ²½μ—μ„œ Spring Boot μ„œλ²„ μ‹€ν–‰ +- Database: Amazon RDS(MySQL)λ₯Ό μ΄μš©ν•œ κ΄€κ³„ν˜• 데이터 관리 +- Storage: Amazon S3λ₯Ό ν™œμš©ν•œ 파일(이미지 λ“±) μ—…λ‘œλ“œ 및 관리 + +3. 데이터 μˆ˜μ§‘ 및 톡신 +- Client: Android μ•±κ³Ό RESTful API(HTTP) 톡신 +- Crawling: Jsoup 라이브러리λ₯Ό μ‚¬μš©ν•˜μ—¬ 학ꡐ μ„œλ²„μ˜ 곡지사항 및 μ‘Έμ—… μš”κ±΄ 데이터 크둀링 +Image + +
+ +## πŸš€ μ£Όμš” κΈ°λŠ₯ (Key Features) + +1. πŸŽ“ μ‘Έμ—… 및 학사 관리 (Graduation Management) +- μ‘Έμ—… μš”κ±΄ 확인: μ‘Έμ—… μš”κ±΄, 성적 사항, κ°œμΈλ³„ 이수 ν˜„ν™©μ„ νƒ­λ³„λ‘œ 상세 쑰회 +- 학사 정보 μ‹œκ°ν™”: ν™ˆ ν™”λ©΄ λŒ€μ‹œλ³΄λ“œ 및 μ‘Έμ—… μ˜ˆμ •μΌ(D-Day) μ„€μ •, μ‘μ›μ˜ ν•œλ§ˆλ”” κΈ°λŠ₯ +- 비ꡐ과 ν™œλ™: 학ꡐ 비ꡐ과 포인트 쑰회 및 관리 + +2. πŸ“… μ‹œκ°„ν‘œ (Timetable) +- μ‹œκ°„ν‘œ 관리: μ‹œκ°„ν‘œ 쑰회, μΆ”κ°€, μˆ˜μ •, μ‚­μ œ κΈ°λŠ₯ +- 상세 검색: ν•™λ…„/학기별, νŠΈλž™λ³„, κ³Όλͺ©λ³„ 검색을 ν†΅ν•œ μ†μ‰¬μš΄ μ‹œκ°„ν‘œ ꡬ성 + +3. πŸ“‚ 컀리어 및 μŠ€νŽ™ μŒ“κΈ° (Career & Portfolio) +- 컀리어 관리: ν™œλ™ 기둝 μ €μž₯, μˆ˜μ •, μ‚­μ œ 및 μΉ΄ν…Œκ³ λ¦¬λ³„ λͺ©λ‘ 쑰회/검색 +- 자격증 관리: μ·¨λ“ν•œ 자격증 μΆ”κ°€, 쑰회, μˆ˜μ •, μ‚­μ œ +- λ©”λͺ¨ κΈ°λŠ₯: 자유둜운 λ©”λͺ¨ μž‘μ„±(μΆ”κ°€/쑰회/μˆ˜μ •/μ‚­μ œ)을 ν†΅ν•œ 일정 및 ν•  일 관리