AWESOMEDEV
111590104e
- 로그인/회원가입/아이디찾기/비밀번호재설정 (세션 기반) - 대시보드(주차별 진도 체크리스트), 학습 문서 뷰어(17종), 과제 제출/멘토 피드백 - 코딩 기초·개발 환경 설치 가이드 학습 페이지 - 전 소스 한국어 학습 주석 — 수습생 교육용 저장소 - Docker 배포 구성 (Caddy + Spring Boot + PG + Gitea) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
117 lines
5.3 KiB
Markdown
117 lines
5.3 KiB
Markdown
# 미림 앱 (mirim-app) — 어썸데브 수습 학습 플랫폼
|
|
|
|
> **이 저장소는 여러분(수습생)의 것입니다.**
|
|
> 미림마이스터고 수습생 4명이 직접 보고, 배우고, 고치는 학습용 웹 앱입니다.
|
|
> 처음에는 문서를 읽는 곳이지만, 5~6주차부터는 여러분이 직접 기능을 붙이고 버그를 고치는 실전 연습장이 됩니다.
|
|
> 코드를 읽는 법이 궁금하면 [STUDY.md](./STUDY.md)부터 열어 보세요.
|
|
|
|
## 무엇을 하는 앱인가?
|
|
|
|
- 수습 기간(6주) 동안 필요한 **학습 문서**(가이드·커리큘럼·수업자료·과제)를 한곳에서 봅니다.
|
|
- 주차별 **체크리스트**로 오늘 할 일을 확인하고 체크합니다.
|
|
- **과제를 제출**하고, 멘토에게 **피드백**을 받습니다.
|
|
- 멘토는 전체 제출물을 한 화면에서 검토합니다.
|
|
|
|
## 기술 스택
|
|
|
|
| 영역 | 기술 | 비고 |
|
|
|---|---|---|
|
|
| 프론트엔드 | React + Vite | `frontend/` — 브라우저에서 돌아가는 화면 |
|
|
| 백엔드 | Spring Boot 3 + Java 21 | `backend/` — API 서버 |
|
|
| 데이터베이스 | PostgreSQL 17 | Docker 컨테이너로 실행 |
|
|
| 인프라 | Docker Compose | 로컬에서 DB를 띄우는 용도 |
|
|
|
|
## 폴더 구조
|
|
|
|
```
|
|
mirim-app/
|
|
├── README.md ← 지금 읽는 파일 (프로젝트 소개·실행법)
|
|
├── STUDY.md ← 수습생용 "이 코드로 배우는 법"
|
|
├── docker-compose.yml ← PostgreSQL을 띄우는 설정
|
|
├── backend/ ← Spring Boot API 서버
|
|
│ ├── pom.xml ← 자바 의존성(라이브러리) 목록
|
|
│ └── src/main/
|
|
│ ├── java/dev/awesomedev/mirim/
|
|
│ │ ├── MirimApplication.java ← 앱 시작점
|
|
│ │ ├── domain/ ← 엔티티(DB 테이블과 짝이 되는 클래스)
|
|
│ │ ├── repository/ ← DB를 읽고 쓰는 계층
|
|
│ │ ├── service/ ← 비즈니스 로직(규칙) 계층
|
|
│ │ ├── controller/ ← HTTP 요청을 받는 계층
|
|
│ │ └── config/ ← 보안·시드 등 설정
|
|
│ └── resources/
|
|
│ ├── application.yml ← 서버 설정(DB 접속 정보 등)
|
|
│ └── seed/ ← 초기 데이터 JSON (문서·체크리스트·과제)
|
|
└── frontend/ ← React 화면
|
|
├── package.json ← JS 의존성 목록
|
|
├── index.html ← 브라우저가 처음 여는 파일
|
|
├── public/docs/ ← 학습 문서 HTML 17개 (앱이 iframe으로 보여줌)
|
|
└── src/
|
|
├── pages/ ← 화면 단위 컴포넌트 (로그인, 대시보드, 문서, 과제…)
|
|
├── components/ ← 여러 화면에서 재사용하는 조각 컴포넌트
|
|
└── api/ ← 백엔드 API를 부르는 함수 모음
|
|
```
|
|
|
|
## 로컬 실행법 (3단계)
|
|
|
|
### 0. 준비물
|
|
- Docker Desktop
|
|
- Java 21 (JDK)
|
|
- Node.js 20 이상
|
|
|
|
### 1. 데이터베이스 켜기
|
|
```bash
|
|
# 프로젝트 루트(mirim-app/)에서
|
|
docker compose up -d
|
|
```
|
|
PostgreSQL이 컨테이너로 뜹니다. `docker ps`로 확인하세요.
|
|
|
|
### 2. 백엔드 켜기
|
|
```bash
|
|
cd backend
|
|
./mvnw spring-boot:run # mvnw가 안 되면: mvn spring-boot:run
|
|
```
|
|
`http://localhost:8080` 에서 API 서버가 돌아갑니다. 첫 실행 시 시드 데이터(문서·체크리스트·과제·계정)가 자동으로 들어갑니다.
|
|
|
|
### 3. 프론트엔드 켜기
|
|
```bash
|
|
cd frontend
|
|
npm install # 최초 1회
|
|
npm run dev
|
|
```
|
|
브라우저에서 **http://localhost:5173** 을 열면 로그인 화면이 보입니다.
|
|
|
|
## 초기 계정
|
|
|
|
| 아이디 | 비밀번호 | 역할 |
|
|
|---|---|---|
|
|
| student1 ~ student4 | `mirim2026!` | 수습생 (STUDENT) |
|
|
| mentor1 | `mirim2026!` | 멘토 (MENTOR) |
|
|
|
|
> ⚠️ **실서비스로 쓰기 전에는 반드시 비밀번호를 변경하세요.** 이 계정들은 로컬 학습용입니다.
|
|
|
|
## 환경변수
|
|
|
|
기본값이 로컬 개발에 맞춰져 있어서, 그냥 실행하면 대부분 그대로 동작합니다.
|
|
|
|
| 변수 | 기본값 | 설명 |
|
|
|---|---|---|
|
|
| `DB_HOST` | `localhost` | PostgreSQL 호스트 |
|
|
| `DB_PORT` | `5432` | PostgreSQL 포트 |
|
|
| `DB_NAME` | `mirim` | 데이터베이스 이름 |
|
|
| `DB_USER` | `mirim` | DB 사용자 |
|
|
| `DB_PASSWORD` | (docker-compose.yml 참고) | DB 비밀번호 |
|
|
| `SERVER_PORT` | `8080` | 백엔드 포트 |
|
|
|
|
> 🔒 **시크릿(비밀번호·키)은 절대 커밋하지 마세요.**
|
|
> 로컬 기본값은 학습 편의를 위한 것이고, 실제 배포용 비밀번호·키는 `.env` 같은 별도 파일에 두고 `.gitignore`에 등록합니다. "일단 코드에 박아 두고 나중에 지우지"는 통하지 않습니다 — git 이력에 영원히 남습니다.
|
|
|
|
## 자주 겪는 문제
|
|
|
|
- **백엔드가 DB에 못 붙어요** → `docker compose up -d`를 먼저 했는지, `docker ps`에 postgres가 있는지 확인.
|
|
- **5173 화면은 뜨는데 로그인이 안 돼요** → 백엔드(8080)가 켜져 있는지 확인. 프론트는 API를 백엔드로 보냅니다.
|
|
- **포트가 이미 사용 중이래요** → 이전에 켜 둔 서버가 남아 있을 수 있어요. 터미널을 확인하고 종료하세요.
|
|
|
|
---
|
|
|
|
AWESOMEDEV (어썸데브) · 수습 온보딩 프로그램 학습용 저장소
|