Skip to content

Commit ec0fe6a

Browse files
authored
Create README.md
1 parent 98aa3b6 commit ec0fe6a

1 file changed

Lines changed: 92 additions & 0 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# FOSSistant πŸš€
2+
3+
FOSSistantλŠ” **μ˜€ν”ˆμ†ŒμŠ€ ν”„λ‘œμ νŠΈ κΈ°μ—¬λ₯Ό λ•λŠ” AI 기반 μ–΄μ‹œμŠ€ν„΄νŠΈ**μž…λ‹ˆλ‹€.
4+
GitHub 이슈 뢄석, ν•΄κ²° λ°©μ•ˆ μ œμ‹œ, κΈ°μ—¬ κ°€μ΄λ“œ μ œκ³΅μ„ 톡해 μ˜€ν”ˆμ†ŒμŠ€ μƒνƒœκ³„ μ°Έμ—¬λ₯Ό μ§€μ›ν•©λ‹ˆλ‹€.
5+
6+
## πŸ“‹ μ£Όμš” κΈ°λŠ₯
7+
8+
### πŸ” 이슈 뢄석 & μš”μ•½
9+
- GitHub 이슈의 μžλ™ 뢄석 및 μš”μ•½
10+
- LLM 기반 이슈 λ‚΄μš© 이해 및 μ€‘μš” 포인트 ν•˜μ΄λΌμ΄νŒ…
11+
- ν”„λ‘œμ νŠΈ μ»¨ν…μŠ€νŠΈλ₯Ό κ³ λ €ν•œ λ§žμΆ€ν˜• ν•΄κ²° λ°©μ•ˆ μ œμ‹œ
12+
13+
### πŸ“š κΈ°μ—¬ κ°€μ΄λ“œ
14+
- ν”„λ‘œμ νŠΈλ³„ Contributing κ°€μ΄λ“œ μ—°κ²°
15+
- README.md, 이슈 ν…œν”Œλ¦Ώ λ“± κ΄€λ ¨ λ¬Έμ„œ 링크 제곡
16+
- 디렉토리 ꡬ쑰 뢄석을 ν†΅ν•œ μ½”λ“œ κΈ°μ—¬ κ°€μ΄λ“œ
17+
18+
### πŸ” μ‚¬μš©μž 인증
19+
- GitHub OAuth 2.0 연동
20+
- JWT 기반 토큰 인증
21+
- μ‚¬μš©μžλ³„ 맞좀 μ„œλΉ„μŠ€ 제곡
22+
23+
### πŸ“Š λͺ¨λ‹ˆν„°λ§
24+
- Spring Boot Actuator 기반 ν—¬μŠ€μ²΄ν¬
25+
- Redis 캐싱을 ν†΅ν•œ μ„±λŠ₯ μ΅œμ ν™”
26+
27+
## πŸ›  기술 μŠ€νƒ
28+
29+
### Backend
30+
- **Java 17** - μ–Έμ–΄
31+
- **Spring Boot 3.4.5** - ν”„λ ˆμž„μ›Œν¬
32+
- **Spring Security** - λ³΄μ•ˆ
33+
- **Spring Data JPA** - 데이터 μ ‘κ·Ό
34+
35+
### Database & Cache
36+
- **MySQL** - μ£Ό λ°μ΄ν„°λ² μ΄μŠ€ (Azure MySQL)
37+
- **Redis** - 캐싱 & μ„Έμ…˜ 관리
38+
39+
### AI & External APIs
40+
- **Google Gemini API** - LLM 기반 이슈 뢄석
41+
- **GitHub GrpahQLAPI** - μ €μž₯μ†Œ 및 이슈 데이터 연동
42+
43+
### Infrastructure
44+
- **Docker** - μ»¨ν…Œμ΄λ„ˆν™”
45+
- **Docker Compose** - 둜컬 개발 ν™˜κ²½
46+
47+
### Documentation
48+
- **SpringDoc OpenAPI** - API λ¬Έμ„œ μžλ™ 생성
49+
50+
51+
## πŸ“ ν”„λ‘œμ νŠΈ ꡬ쑰
52+
53+
```
54+
src/main/java/Capstone/FOSSistant/
55+
β”œβ”€β”€ FosSistantApplication.java # 메인 μ• ν”Œλ¦¬μΌ€μ΄μ…˜
56+
└── global/ # μ „μ—­ μ„€μ • 및 곡톡 κΈ°λŠ₯
57+
β”œβ”€β”€ config/ # μŠ€ν”„λ§ μ„€μ •
58+
β”œβ”€β”€ security/ # λ³΄μ•ˆ μ„€μ •
59+
β”œβ”€β”€ domain/ # μ—”ν‹°ν‹° λͺ¨λΈ
60+
β”œβ”€β”€ repository/ # 데이터 μ ‘κ·Ό 계측
61+
β”œβ”€β”€ service/ # λΉ„μ¦ˆλ‹ˆμŠ€ 둜직
62+
β”œβ”€β”€ web/ # μ›Ή 계측 (컨트둀러)
63+
β”œβ”€β”€ apiPayload/ # API μš”μ²­/응닡 DTO
64+
β”œβ”€β”€ converter/ # 데이터 λ³€ν™˜
65+
β”œβ”€β”€ Validator/ # μž…λ ₯κ°’ 검증
66+
└── aop/ # 관점 μ§€ν–₯ ν”„λ‘œκ·Έλž˜λ°
67+
```
68+
69+
## πŸ”§ μ£Όμš” μ„€μ •
70+
71+
### JVM μ˜΅μ…˜
72+
```bash
73+
-Xmx512m -Xms256m # λ©”λͺ¨λ¦¬ μ œν•œ (Docker ν™˜κ²½)
74+
```
75+
76+
### Redis μ„€μ •
77+
```yaml
78+
# μ΅œλŒ€ λ©”λͺ¨λ¦¬: 256MB
79+
# μ •μ±…: allkeys-lru (κ°€μž₯ 였래된 ν‚€ μ‚­μ œ)
80+
```
81+
82+
### ν—¬μŠ€μ²΄ν¬
83+
- **μ—”λ“œν¬μΈνŠΈ**: `/actuator/health`
84+
- **간격**: 30초
85+
- **νƒ€μž„μ•„μ›ƒ**: 10초
86+
- **μž¬μ‹œλ„**: 3회
87+
88+
## πŸ“„ λΌμ΄μ„ μŠ€
89+
90+
이 ν”„λ‘œμ νŠΈλŠ” [λΌμ΄μ„ μŠ€ 파일](LICENSE)에 λͺ…μ‹œλœ 쑰건에 따라 λ°°ν¬λ©λ‹ˆλ‹€.
91+
92+
**FOSSistant**둜 μ˜€ν”ˆμ†ŒμŠ€ κΈ°μ—¬λ₯Ό 더 쉽고 즐겁게 λ§Œλ“€μ–΄λ³΄μ„Έμš”! πŸŽ‰

0 commit comments

Comments
Β (0)