Skip to content

Commit e229c71

Browse files
authored
Docs(README): update frontend & main README.md (#90)
1 parent 59449bd commit e229c71

2 files changed

Lines changed: 33 additions & 7 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,31 @@ _"폭넓은 가능성 속에서, 각자의 길을 찾고 준비할 수 있도록
3636
- 실제 합격자 자소서, 스펙 사례 기반 현실적 준비 방법 제시
3737
- 관심 직무 기반 맞춤형 정보 탐색 기능 제공
3838

39+
## 🧩 주요 기능 (Key Features)
40+
### 🖥️ 프론트엔드 기능
41+
[프론트엔드 README](./spec-trackr-app/README.md)
42+
43+
### 🛠️ 백엔드 기능
44+
[백엔드 README](./API/README.md)
45+
46+
## 🧰 기술 스택
47+
| 구분 | 기술 |
48+
|-----------|-----------------------|
49+
| Backend | Swagger, FastAPI |
50+
| Frontend | React, Tableau |
51+
| DB | PostgreSQL |
52+
| DevOps | GitHub, Docker |
53+
54+
## 🚀 사용자 가이드
55+
```bash
56+
# 2025_Advanced_Programming 디렉토리에서 아래 명령어 실행
57+
docker compose up
58+
# 브라우저에서 아래 URL 접속
59+
http://localhost:3002
60+
```
61+
### 💡 문제 해결
62+
브라우저에 접속 시 화면이 뜨지 않는 경우
63+
- VSCode의 Ports에 3002를 추가한 후 URL 재접속
3964

4065
## 🧑 팀 소개 (Team)
4166

spec-trackr-app/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SpecTrackr 프로젝트 개요 및 컴포넌트 설명
1+
# SpecTrackr Frontend 개요 및 컴포넌트 설명
22

33
---
44

@@ -7,14 +7,14 @@
77
**SpecTrackr**는 사용자가 직업(분야), 회사, 직무에 따른 채용 정보와 지원자 스펙 정보를 검색할 수 있는 React 기반 웹 애플리케이션이다.
88
주요 기능은 크게 두 가지 검색 방식으로 나누어진다:
99

10-
- **회사 기준 검색** (`com_sp.jsx`)
11-
- **스펙 기준 검색** (`sp_com.jsx`)
10+
- **채용공고 검색** (`com_sp.jsx`)
11+
- **스펙 검색** (`sp_com.jsx`)
1212

1313
---
1414

1515
## 2. 파일 설명 및 주요 기능
1616

17-
### 2.1 `com_sp.jsx`회사 기준 검색 컴포넌트
17+
### 2.1 `com_sp.jsx`채용공고 검색 컴포넌트
1818

1919
#### 역할
2020
사용자가 직업 분류 → 회사 → 직무 순으로 필터링하여 해당 조건에 맞는 채용 공고를 조회할 수 있도록 한다.
@@ -25,7 +25,7 @@
2525
- 회사 선택 시 그 회사에 맞는 직무만 필터링, 직무 선택 시 그 직무에 맞는 회사만 필터링 (상호 필터링)
2626
- 세 가지 조건(직업 분류, 회사, 직무)이 모두 선택되면 해당 조건에 맞는 채용 공고 데이터를 API에서 받아 화면에 출력
2727
- 채용 공고는 이미지가 있으면 이미지로, 없으면 텍스트 상세 정보로 보여줌
28-
- 상단 탭 버튼으로 ‘회사 기준 검색’과 ‘스펙 기준 검색’ 간 전환 (후자는 `sp_com.jsx` 컴포넌트)
28+
- 상단 탭 버튼으로 ‘채용공고 검색’과 ‘스펙 검색’ 간 전환 (후자는 `sp_com.jsx` 컴포넌트)
2929

3030
#### 주요 상태값(State)
3131
| 상태명 | 설명 |
@@ -50,7 +50,7 @@
5050

5151
---
5252

53-
### 2.2 `sp_com.jsx` — 스펙 기준 검색 컴포넌트
53+
### 2.2 `sp_com.jsx` — 스펙 검색 컴포넌트
5454

5555
#### 역할
5656
사용자가 회사와 직무를 선택하고 본인의 스펙(학력, 성적, 사회경험, 어학, 수상, 자격증)을 입력하면 해당 조건에 맞는 합격자 스펙을 조회하고 추천해주는 기능을 제공한다.
@@ -61,7 +61,8 @@
6161
- 사용자 스펙 입력 폼 제공 (학교, 성적, 사회경험, 어학, 수상, 자격증)
6262
- 입력한 스펙과 선택한 회사/직무 조건에 맞는 합격자 데이터를 API에서 받아 추천 및 순서대로 조회 가능
6363
- 추천 합격자 리스트는 캐러셀 형식으로 표시, 사용자 클릭으로 다음/이전 지원자 보기 가능
64-
- 상단 탭 버튼으로 ‘스펙 기준 검색’과 ‘회사 기준 검색’ 간 전환 (후자는 `com_sp.jsx` 컴포넌트)
64+
- 직무별 스펙 시각화: Tableau 리포트를 통해 직무별 합격자 스펙 정보를 워드클라우드 형태로 시각화하여 제공
65+
- 상단 탭 버튼으로 ‘스펙 검색’과 ‘채용공고 검색’ 간 전환 (후자는 `com_sp.jsx` 컴포넌트)
6566

6667
#### 주요 상태값(State)
6768
| 상태명 | 설명 |

0 commit comments

Comments
 (0)