Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 74 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,44 +5,47 @@
> 간단한 한 줄 소개 – 프로젝트의 핵심 가치 또는 기능

[![Swift](https://img.shields.io/badge/Swift-5.9-orange.svg)]()
[![Xcode](https://img.shields.io/badge/Xcode-15.0-blue.svg)]()
[![Xcode](https://img.shields.io/badge/Xcode-26.0-blue.svg)]()
[![License](https://img.shields.io/badge/license-MIT-green.svg)]()

---

## 🗂 목차
- [소개](#소개)
- [프로젝트 기간](#프로젝트-기간)
- [기술 스택](#기술-스택)
- [기능](#기능)
- [시연](#시연)
- [폴더 구조](#폴더-구조)
- [팀 소개](#팀-소개)
- [Git 컨벤션](#git-컨벤션)
- [테스트 방법](#테스트-방법)
- [프로젝트 문서](#프로젝트-문서)
- [라이선스](#lock_with_ink_pen-license)

---
<br>
<br>

## 📱 소개

> 프로젝트의 주요 목적과 사용자가 얻게 될 경험을 설명해주세요.

[🔗 앱스토어/웹 링크](https://example.com)

<br>

## 📆 프로젝트 기간
- 전체 기간: `YYYY.MM.DD - YYYY.MM.DD`
- 개발 기간: `YYYY.MM.DD - YYYY.MM.DD`
- 전체 기간: `2025.09.01 - 2025.11.28`
- 개발 기간: `2025.10.23 - 2025.11.21`

<br>

## 🛠 기술 스택

- Swift / SwiftUI / UIKit / Firebase 등
- 아키텍처: MVVM / MVC / Clean Architecture 등
- 기타 도구: Figma, Notion, GitHub Projects 등
### Envrionment
<div align="left">
<img src="https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white" />
</div>

### Development
<div align="left">
<img src="https://img.shields.io/badge/Xcode-007ACC?style=for-the-badge&logo=Xcode&logoColor=white" />
<img src="https://img.shields.io/badge/SwiftUI-42A5F5?style=for-the-badge&logo=swift&logoColor=white" />
</div>

### Communication
<div align="left">
<img src="https://img.shields.io/badge/Miro-FFFC00.svg?style=for-the-badge&logo=Miro&logoColor=050038" />
<img src="https://img.shields.io/badge/Notion-white.svg?style=for-the-badge&logo=Notion&logoColor=000000" />
<img src="https://img.shields.io/badge/Figma-F24E1E?style=for-the-badge&logo=figma&logoColor=white" />
</div>

<br>

## 🌟 주요 기능

Expand All @@ -52,6 +55,7 @@

> 필요시 이미지, GIF, 혹은 링크 삽입

<br>

## 🖼 화면 구성 및 시연

Expand All @@ -60,6 +64,7 @@
| 예시1 | 기능 요약 | ![gif](링크) |
| 예시2 | 기능 요약 | ![gif](링크) |

<br>

## 🧱 폴더 구조

Expand All @@ -74,44 +79,64 @@
┗ 📂Resources
```

<br>

## 🧑‍💻 팀 소개

| 이름 | 역할 | GitHub |
|------|------|--------|
| 홍길동 | iOS Developer | [@hong](https://github.com/hong) |
| 김개발 | PM | [@devkim](https://github.com/devkim) |
### Openock = Open + (k)nock

[🔗 팀 블로그 / 미디엄 링크](https://medium.com/example)
모두가 접근할 수 있는 열린 세상을 두드리는 팀

## 🔖 브랜치 전략
`(예시)`
- `main`: 배포 가능한 안정 버전
- `develop`: 통합 개발 브랜치
- `feature/*`: 기능 개발 브랜치
- `bugfix/*`: 버그 수정 브랜치
- `hotfix/*`: 긴급 수정 브랜치
| <img width="401" height="401" alt="enoch" src="https://github.com/user-attachments/assets/e67f2fa3-f9da-4451-a402-e8fac8166b07" /> | <img width="401" height="401" alt="leon" src="https://github.com/user-attachments/assets/3dba1c59-c360-452b-9599-5342a7d733a9" /> | <img width="401" height="401" alt="mary" src="https://github.com/user-attachments/assets/9104e718-b46a-440c-aefd-79539ce9efa8" /> | <img width="401" height="401" alt="paduck" src="https://github.com/user-attachments/assets/d14d6389-63ef-476a-8291-077a2091b2ca" /> | <img width="401" height="401" alt="root" src="https://github.com/user-attachments/assets/ecf81805-6447-4585-b576-3416618308fe" /> | <img width="401" height="401" alt="Frame-4" src="https://github.com/user-attachments/assets/ea08566f-1a37-43dd-9808-2e0d6110cc89" /> |
|:------:|:------:|:------:|:------:|:------:|:------:|
| [**Enoch (한혜빈)**](https://github.com/HanHyeBeen)<br>*Tech*| [**Leon (김혜서)**](https://github.com/being0825)<br>*Design* | [**Mary (임희서)**](https://github.com/Ellyhs)<br>*Tech* | [**Paduck (서용원)**](https://github.com/paohree)<br>*Tech* | [**Root (맹지주)**](https://github.com/maengjj)<br>*Tech* | [**Wendy (윤예람)**](https://github.com/altol2)<br>*Design* |

## 🌀 커밋 메시지 컨벤션
`(예시)`
[Gitmoji](https://gitmoji.dev) + [Conventional Commits](https://www.conventionalcommits.org)
<br><br><br>

### 예시
- ✨ feat: 로그인 화면 추가
- 🐛 fix: 홈 진입 시 크래시 수정
- ♻️ refactor: 데이터 모델 구조 정리

## Xcode Formatting
- 각 라인이 너무 길어지면(100자 초과) 개행한다.
- 들여쓰기는 공백 문자 2개로 한다.

## ✅ 테스트 방법
<br>

1. 이 저장소를 클론합니다.
```bash
git clone https://github.com/yourteam/project.git
```
2. `Xcode`로 `.xcodeproj` 또는 `.xcworkspace` 열기
3. 시뮬레이터 환경 설정: iPhone 15 / iOS 17
4. `Cmd + R`로 실행 / `Cmd + U`로 테스트 실행
## 작업 순서
1. git pull 의 생활화
2. 작업 시작 전 이슈 작성
3. 작업 당 하나 이상의 브랜치 생성
4. 작업
5. 이슈를 참조하는 PR 작성
6. PR에 대한 팀원들의 코드 리뷰 권장 (내 xcode로 실행해보고 남기기)
7. 나 제외 1명 이상의 Approve를 받아야 dev에 머지 가능함

<br>

## Branch Convention
`예시: feat/#123-content-view`
무조건 소문자, 띄어쓰기 없음, 띄어쓰기 하고 싶으면 '-' 붙이기
* main – 실제 제품이 배포되는 ****최종 릴리스 브랜치***
* dev – 다음 배포를 위한 기능들이 통합되는 ****중간 개발 브랜치***
* feat/xx – 새로운 기능을 개발하기 위한 ****기능 단위 브랜치***
* refac/xx – 기존 코드 구조를 개선하기 위한 ****리팩토링 브랜치***
* fix/xx - 기능이든 디자인이든 ****코드 수정용 브랜치***
* chore/xx – 빌드 설정, 패키지 관리, 문서화 등 비기능적 작업을 위한 ****잡무용 브랜치***
* design/xx – UI/UX 관련 수정 및 디자인 변경을 위한 ****디자인 반영 브랜치***
* hotfix/xx – 서비스에서 발생한 문제를 긴급 수정하는 ****핫픽스 브랜치***
* release/0.0.1 - 배포를 위한 전용 브랜치

<br>

## Commit Convention
`예시: feat: #123 _ 설명 한글로`
* feat: 기능 상의 변경사항
* fix: 버그 수정
* docs: 문서 추가, 수정
* lint: 코드 스타일 수정. 인터페이스와 기능 상의 변화가 없어야 함.
* refactor: 리팩토링. 기능 상의 변화가 없어야 함.
* assets: 프로젝트 내에 직접 포함되어야 하는 이미지, 비디오 등의 에셋이 추가되거나 변경된 경우.
* chore: 프로덕트의 기능에 변경점이 없으면서 위의 모든 경우에 해당하지 않는 경우. 설정 등.

<br>

## 📎 프로젝트 문서

Expand Down